Returns the parameters to be filled before running a document refresh.
GET <webiURL>/documents/{documentId}/parameters?lovInfo={true|false}
Where:
Response type: application/xml or application/json
The response provides the parameters with their expected answers, previous values if applicable, otherwise default values. See Parameter XML Grammar to learn about the XML content structure and element details.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <parameters/>
The parameter of type context provides two possible context values.
<parameters> <parameter optional="false" type="context" dpId="DP0"> <id>0</id> <technicalName>0</technicalName> <name>Select a context</name> <answer constrained="true" type="Text"> <info cardinality="Multiple"> <lov partial="false"> <values> <value id="2">Reservations</value> <!-- possible values --> <value id="1">Sales</value> </values> </lov> <previous> <value id="2">Reservations</value> <!-- previous value --> </previous> </info> <values> <value id="2">Reservations</value> <!-- previous value --> </values> </answer> </parameter> </parameters>
The parameter of type prompt accepts only one answer value (cardinality Single).
<parameters> <parameter optional="false" type="prompt" dpId="DP01"> <id>0</id> <name>Enter Open Date:</name> <answer constrained="false" type="DateTime"> <info cardinality="Single"> <previous> <value>1992-09-03T17:15:00.000+02:00</value> <!-- previous value --> </previous> </info> <values> <value>1992-09-03T17:15:00.000+02:00</value> <!-- previous value --> </values> </answer> </parameter> </parameters>
The parameter of type prompt accepts multiple answer values (cardinality Multiple).
<parameters> <parameter optional="false" type="prompt" dpId="DP0"> <id>0</id> <technicalName>Enter values for Customer:</technicalName> <name>Enter values for Customer:</name> <answer constrained="false" type="Text"> <info cardinality="Multiple"> <lov hierarchical="false" refreshable="true"> <id>UNIVERSELOV_DS0.DOd</id> <intervals> <interval id="0"> <value>Arai</value> <value>Okumura</value> </interval> <interval id="1"> <value>Oneda</value> <value>Wilson</value> </interval> </intervals> <values> <value>Arai</value> <!-- possible values --> <value>Baker</value> <value>Brendt</value> . . . <value>Okumura</value> </values> <columns mappingId="0"> <column id="0" type="string">Customer </column> </columns> </lov> <previous> <value>Arai</value> <!-- previous values --> <value>Baker</value> <value>Brendt</value> <value>Diemers</value> <value>Dupont</value> <value>Durnstein</value> <value>Edwards</value> </previous> <values> <value>Arai</value> <!-- previous values --> <value>Baker</value> <value>Brendt</value> <value>Diemers</value> <value>Dupont</value> <value>Durnstein</value> <value>Edwards</value> </values> </answer> </parameter> . . . </parameters>
The parameter of type prompt accepts one answer value (cardinality Single) from a list of values made of three columns. The first one (mappingId="0") is used as reference.
<parameter optional="false" type="prompt" dpId="DP15"> <id>6</id> <technicalName>Enter values for Customer:</technicalName> <name>Enter values for Customer:</name> <answer constrained="false" type="Text"> <info cardinality="Single"> <lov hierarchical="false" refreshable="true"> <id>UNIVERSELOV_DS2.DOea</id> <intervals> <interval id="0"> <cvalue> <column id="0">William</column> <column id="1">64</column> <column id="2">1995-12-19T02:00:00.000+01:00</column> </cvalue> <cvalue> <column id="0">Silke</column> <column id="1">63</column> <column id="2">1994-03-25T02:00:00.000+01:00</column> </cvalue> </interval> <interval id="1"> . . . </interval> </intervals> <cvalues> <cvalue> <column id="0">Werner</column> <column id="1">42</column> <column id="2">1995-06-08T08:28:00.000+02:00</column> </cvalue> . . . <cvalue> <column id="0">Tony</column> <column id="1">55</column> <column id="2">1995-07-05T04:00:00.000+02:00</column> </cvalue> </cvalues> <columns mappingId="0"> <column id="0" type="string">Customer</column> <column id="1" type="double">Age </column> <column id="2" type="date_time">Invoice Date </column> </columns> </lov> <previous> <value>Andre</value> </previous> </info> <values> <value>Andre</value> </values> </answer> </parameter>