A GET .../parameters call returns a list of values for a specific parameter of type prompt and of which lists of values are indexed ("<value id="...">...</value>"). Only the value ID is mandatory.
The response contains the prompts at the first level in the hierarchy (hierarchical="true"). There is only one column of type String. final="false" means the value is a node of the hierarchy, while final="true" or no tag means value is a leaf.
Response:
<parameters> <parameter optional="false" type="prompt" dpId="DP0"> <id>0</id> <technicalName>customer Hierarchy Node variable mandatory</technicalName> <name>customer Hierarchy Node variable mandatory</name> <answer constrained="true" type="Text"> <info cardinality="Single"> <lov hierarchical="true" partial="false" refreshable="true" searchable="false"> <id>UNIVERSELOV_DS0.DO48</id> <cvalues> <cvalue id="[Z_COUNTRY COUNTRY_HIERARCHY_01].[WORLD 0HIER_NODE]" final="false"> <column id="0">WORLD 0HIER_NODE</column> <column id="1">WORLD</column> </cvalue> <cvalue id="[Z_COUNTRY COUNTRY_HIERARCHY_01].[REST_H 1HIER_REST]" final="false"> <column id="0">REST_H 1HIER_REST</column> <column id="1">Not Assigned Country (s)</column> </cvalue> </cvalues> <columns mappingId="0"> <column id="0" type="String">LovHierNodeL00 CountryBase </column> <column id="1" type="String">LovHierNodeL00 Country </column> </columns> </lov> <previous> <value id="[Z_COUNTRY COUNTRY_HIERARCHY_01].[0013]">0013</value> </previous> </info> <values> <value id="[Z_COUNTRY COUNTRY_HIERARCHY_01].[0013]">0013</value> </values> </answer> </parameter> </parameters>
In the first PUT call, the ID of the first level of the list of values is given as answer to the parameter. Hierarchical lists of values accept an extra <path> element in the <query> section to go down to each level of the hierarchical parameter.
Request body:
<parameters> <parameter> <id>0</id> <answer> <info> <lov> <query> <path> <value id="[Z_COUNTRY COUNTRY_HIERARCHY_01].[WORLD 0HIER_NODE]"/> </path> </query> </lov> </info> </answer> </parameter> </parameters>
The response contains the list of values of the second level of the parameter. The path attribute of the lov element describes the path to any value of the list of values returned in the call. The syntax [0|1|2,\ ,\ ID] describes the value type and ID of a level (0 for string, 1 for date, 2 for numeric).
Response:
<parameters> <parameter optional="false" type="prompt" dpId="DP0"> <id>0</id> <technicalName>customer Hierarchy Node variable mandatory</technicalName> <name>customer Hierarchy Node variable mandatory</name> <answer constrained="true" type="Text"> <info cardinality="Single"> <lov hierarchical="true" partial="false" refreshable="true" searchable="false" path="[[0,\ , \ [Z_COUNTRY COUNTRY_HIERARCHY_01].[WORLD 0HIER_NODE]]]"> <id>UNIVERSELOV_DS0.DO48</id> <cvalues> <cvalue id="[Z_COUNTRY COUNTRY_HIERARCHY_01].[EUROPE 0HIER_NODE]" final="false"> <column id="0">EUROPE 0HIER_NODE</column> <column id="1">EUROPE</column> </cvalue> <cvalue id="[Z_COUNTRY COUNTRY_HIERARCHY_01].[NORTH_AMERICA 0HIER_NODE]" final="false"> <column id="0">NORTH_AMERICA 0HIER_NODE</column> <column id="1">NORTH_AMERICA</column> </cvalue> <cvalue id="[Z_COUNTRY COUNTRY_HIERARCHY_01].[ASIA_PAC 0HIER_NODE]" final="false"> <column id="0">ASIA_PAC 0HIER_NODE</column> <column id="1">ASIA_PAC</column> </cvalue> <cvalue id="[Z_COUNTRY COUNTRY_HIERARCHY_01].[MIDDLE_EAST 0HIER_NODE]" final="false"> <column id="0">MIDDLE_EAST 0HIER_NODE</column> <column id="1">MIDDLE_EAST</column> </cvalue> </cvalues> <columns mappingId="0"> <column id="0" type="String">LovHierNodeL01 CountryBase </column> <column id="1" type="String">LovHierNodeL01 Country </column> </columns> </lov> <previous> <value id="[Z_COUNTRY COUNTRY_HIERARCHY_01].[0013]">0013</value> </previous> </info> <values> <value id="[Z_COUNTRY COUNTRY_HIERARCHY_01].[0013]">0013</value> </values> </answer> </parameter> </parameters>
In a second PUT call, the value ID of the list of values of the second level is given as answer to the parameter ("[Z_COUNTRY COUNTRY_HIERARCHY_01].[ASIA_PAC 0HIER_NODE]"). The first level value ID is recalled ([Z_COUNTRY COUNTRY_HIERARCHY_01].[WORLD 0HIER_NODE]).
Request body:
<parameters> <parameter> <id>0</id> <answer> <info> <lov> <query> <path> <value id="[Z_COUNTRY COUNTRY_HIERARCHY_01].[WORLD 0HIER_NODE]" /> <value id="[Z_COUNTRY COUNTRY_HIERARCHY_01].[ASIA_PAC 0HIER_NODE]" /> </path> </query> </lov> </info> </answer> </parameter> </parameters>
There is no more final="false" attribute in <cvalue> in the response. The last level of the hierarchy is reached.
Response:
<parameters> <parameter optional="false" type="prompt" dpId="DP0"> <id>0</id> <technicalName>customer Hierarchy Node variable mandatory</technicalName> <name>customer Hierarchy Node variable mandatory</name> <answer constrained="true" type="Text"> <info cardinality="Single"> <lov hierarchical="true" partial="false" refreshable="true" searchable="false" path="[[0,\ , \ [Z_COUNTRY COUNTRY_HIERARCHY_01].[WORLD 0HIER_NODE]]]"> > <id>UNIVERSELOV_DS0.DO48</id> <cvalues> <cvalue id="[Z_COUNTRY COUNTRY_HIERARCHY_01].[0003]"> <column id="0">0003</column> <column id="1">Australia</column> </cvalue> <cvalue id="[Z_COUNTRY COUNTRY_HIERARCHY_01].[0006]"> <column id="0">0006</column> <column id="1">Bangladesh</column> </cvalue> <cvalue id="[Z_COUNTRY COUNTRY_HIERARCHY_01].[0015]"> <column id="0">0015</column> <column id="1">China</column> </cvalue> ... <cvalue id="[Z_COUNTRY COUNTRY_HIERARCHY_01].[0063]"> <column id="0">0063</column> <column id="1">Thailand</column> </cvalue> </cvalues> <columns mappingId="0"> <column id="0" type="String">LovHierNodeL02 CountryBase </column> <column id="1" type="String">LovHierNodeL02 Country </column> </columns> </lov> <previous> <value id="[Z_COUNTRY COUNTRY_HIERARCHY_01].[0013]">0013</value> </previous> </info> <values> <value id="[Z_COUNTRY COUNTRY_HIERARCHY_01].[0013]">0013</value> </values> </answer> </parameter> </parameters>
A last PUT call refreshes the document with a <value>.
Request body:
<parameters> <parameter> <id>0</id> <answer> <values> <value id="[Z_COUNTRY COUNTRY_HIERARCHY_01].[0015]"/> </values> </answer> </parameter> </parameters>
Response:
<success> <message>The resource of type 'Document' with identifier '8816' has been successfully updated.</message> <id>8816</id> </success>