Example - Refreshing a Document with Cascading Parameters

A first GET .../parameters call returns:

  • The list of possible values for the answer to a parameter of id=0, type prompt and cardinality Single (age)
  • A second parameter of id=1, type prompt, and cardinality Single (customer name)

The first parameter needs to be answered so that you can get the list of values of the second parameter. See the <parameters> element inside the <lov> element of the second parameter.

Response:

<parameters>
    <parameter optional="false" type="prompt" dpId="DP11">
        <id>0</id>
        <technicalName>Age:</technicalName>
        <name>Age:</name>
        <answer constrained="false" type="Numeric">
            <info cardinality="Single">
                <lov hierarchical="false" partial="false" refreshable="true">
                    <id>UNIVERSELOV_DS2.DO9</id>
                    <values>
                        <value>18</value>
                        <value>19</value>
                        . . .
                        <value>150</value>
                    </values>
                    <columns mappingId="0">
                        <column id="0" type="Numeric">Age</column>
                    </columns>
                </lov>
            </info>
        </answer>
    </parameter>
    <parameter optional="false" type="prompt" dpId="DP11">
        <id>0</id>
        <technicalName>Enter customer:</technicalName>
        <name>Enter customer:</name>
        <answer constrained="false" type="Text">
            <info cardinality="Single">
                <lov hierarchical="false" refreshable="true">
                    <id>UNIVERSELOV_DS2.DO10c</id>
                    <parameters>
                        <id>0</id>
                    </parameters>
                </lov>
            </info>
        </answer>
    </parameter>
</parameters>

A first PUT .../parameters call answers the first parameter.

Request body:

<parameters>
    <parameter>
        <id>0</id>
        <answer>
            <values>
                <value>25</value>
            </values>
        </answer>
    </parameter>
</parameters>

The response contains the possible values for the second parameter.

Response:

<parameters>
    <parameter optional="false" type="prompt" dpId="DP11">
        <id>1</id>
        <technicalName>Enter customer:</technicalName>
        <name>Enter customer:</name>
        <answer constrained="false" type="Text">
            <info cardinality="Single">
                <lov hierarchical="false" partial="false" refreshable="true">
                    <id>UNIVERSELOV_DS2.DO10c</i>
                    <values>
                        <value>Arrow</value>
                        <value>Baker</value>
                        . . .
                        <value>Wilson</value>
                    </values>
                    <columns mappingId="0">
                        <column id="0" type="String">Customer</column>
                    </columns>
                </lov>
            </info>
        </answer>
    </parameter>
</parameters>
Note Resolving only some of the nested parameters of your document does not allow the main list of values to be filled in with values. If a request body only contains answers to some parameters, the PUT call will return the parameters that need an answer.