Getting the Refresh Parameters

Returns the parameters to be filled before running a document refresh.

Request

GET <webiURL>/documents/{documentId}/parameters?lovInfo={true|false}

Where:

  • {documentId} is the document identifier retrieved from the list of documents
  • lovInfo is an optional, Boolean parameter. Default value is true. If set to false, the lists of values are not computed, nor displayed.
Response

Response type: application/xml or application/json

Response body: the set of parameters to be filled before a refresh.

<parameters>
    <parameter optional="true|false" type="context|prompt" dpId="DP0">  
        <id>...</id>
        <technicalName>0</technicalName>
        <name>...</name>
        <answer constrained="true" type="Text|Numeric|DateTime">
            <info cardinality="Single|Multiple|Interval">
                <lov partial="false">
                    <values>
                        <value id="...">...</value>
                    </values>
                    <previous>
                        <value id="...">...</value>
                    </previous>
                </lov>
            </info>
            <values>
                <value id="...">...</value>
            </values>
        </answer>
    </parameter> 
</parameters>

Where:

  • The optional parameter attribute is true if the parameter is not mandatory
  • The type parameter attribute is either context or prompt
  • The <id> element is the parameter identifier
  • The <name> element is the parameter name
  • The <parameter><answer><values> element cascade represents the answer values. It is prefilled automatically by the web service with previous values if applicable, otherwise with default values.
  • The type answer attribute is either Text, Numeric or DateTime.
  • The cardinality info attribute gives the number of values to expect. It is either Single, Multiple or Interval.
Note DateTime has the format yyyy-mm-ddThh:mm:ss.sss+HH:MM, where HH:MM is the time zone offset. For example 1992-09-03T17:15:00.000+02:00.

Example

No Parameters
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<parameters/>

Example

Context
<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>
                        <!-- Default values -->
                        <value id="2">Reservations</value>
                        <value id="1">Sales</value>
                    </values>
                </lov>
                    <previous>
                        <!-- Previous values -->
                        <value id="2">Reservations</value>
                    </previous>
            </info>
            <!-- Value(s) provided by client -->
            <values>
                <value id="2">Reservations</value>
            </values>
        </answer>
    </parameter>
</parameters>

Example

DateTime Prompt
<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>
            </info>
            <values>
                <value>1992-09-03T17:15:00.000+02:00</value>
            </values>
        </answer>
    </parameter>
</parameters>

Example

LOV details
<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>
                        <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>
                    <value>Baker</value>
                    <value>Brendt</value>
                    <value>Diemers</value>
                    <value>Dupont</value>
                    <value>Durnstein</value>
                    <value>Edwards</value>
                </previous>
            <values>
                <value>Arai</value>
                <value>Baker</value>
                <value>Brendt</value>
                <value>Diemers</value>
                <value>Dupont</value>
                <value>Durnstein</value>
                <value>Edwards</value>
            </values>
        </answer>
    </parameter>
    . . .
</parameters>
Note <intervals/> are not included in the LOV details when there is only one interval.

Example

Multicolumn LOV details

When a LOV accepts multi-columns values, values are represented through the extended <cvalue>, where each column of the value is given:

<cvalue>
    <column id="0">. . .</column>
    <column id="1">. . .</column>
    <column id="2">. . .</column>
    . . .
    <column id="n">. . .</column>
</cvalue>

The corresponding headers (column index, type and name) are given back through <columns> of the LOV information:

<columns mappingId="m">
    <column id="0" type=". . .">. . .</column>
    <column id="1" type=". . .">. . .</column>
    . . .
    <column id="n" type=". . .">. . .</column>
</columns>

Where the mappingId shows the column index whose value needs to be given as answer to refresh a document, but also used as key for sorting:

<parameter optional="false" type="prompt" dpId="DP15">
    <id>6</id>
    <technicalName>Enter values for CustomLOV_3colonnes_AllDataType:</technicalName>
    <name>Enter values for CustomLOV_3colonnes_AllDataType:</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">CustomLOV_3colonnes_AllDataType </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>