Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
titleColor#FFFFFF
titleBGColor#E44313
titleTable of Contents

Table of Contents
outlinetrue
stylenone

Function

The DocumentInfo task queries an XML price list with a specific alias. The alias can be an ID, an UUID or a name, such as "price_list.xml." More information about the XML price list can be found in the HelpCenter.

Description

SP Tabs group
dispositionhorizontal
SP Tab pane
anchor2286824
nameJSON

Route: GET /documentdomain/{aliasname}

There is no need to send a body.

Code Block
languagejs
titleRequest
linenumberstrue
collapsetrue
{
}
Code Block
titleResponse
linenumberstrue
collapsetrue
{
    "stid": "20230213-acc2-dev-1921",
    "data": [
        {
            "created": "2019-04-16T16:36:52.000+0200",
            "updated": "2019-04-16T16:36:52.000+0200",
            "id": 3176,
            "type": "price_list",
            "mimeType": "text/xml",
            "size": 524937,
            "name": "price_list_2019-04-16-163652.xml"
        }
    ]
}
SP Tab pane
anchor87031
nameXML

Task code: 1901004
Uses  Pricelist object

Code Block
languagexml
titleRequest
linenumberstrue
collapsetrue
<request>
	<task>
		<code>1901004</code>
		<document>
			<id>3176</id>
		</document>
	</task>
</request>
Code Block
languagexml
titleResponse
linenumberstrue
collapsetrue
<response>
	<result>
		<data>
			<document>
				<uuid>c65b7d6f-e4ec-48cf-9ac8-8830159a6005</uuid>
				<alias>price_list.xml</alias>
				<owner>
					<user>customer</user>
					<context>4</context>
				</owner>
				<updater>
					<user>rootuser</user>
					<context>1</context>
				</updater>
				<id>3176</id>
				<addon/>
				<type>price_list</type>
				<mime_type>text/xml</mime_type>
				<size>524937</size>
				<name>price_list_example.xml</name>
				<created>2019-04-16 16:36:52</created>
				<updated>2019-04-16 16:36:52</updated>
			</document>
		</data>
		<status>
			<code>S1901004</code>
			<text>The document was inquired successfully.</text>
			<type>success</type>
		</status>
	</result>
	<stid>20230213-app2-dev-38643</stid>
</response>