Getting the List of Parameters

Usage

Returns the first contexts or parameters to be answered.

Request

GET /queries/<queryID>/parameters

Where:
  • <queryID> is the query identifier retrieved from the list of queries
Response

Response type: application/xml or application/json

The response provides the parameters with their expected answers and default values. See Parameter Response Body Schemas to learn about the XML content structure and element details.

Example

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

Example

Context

The parameter of type context provides two possible context values.

<parameters>
    <parameter type="context" optional="false" dpId="DP0" >
        <id>0</id>
        <name>Select a context</name>
        <answer type="text" constrained="true">
            <info cardinality="Single">
                <lov partial="false">
                    <values>
                        <value id="C2">Reservations</value>
                        <value id="C1">Sales</value>
                    </values>
                </lov>
            </info>
        </answer>
    </parameter>
</parameters>

Example

DateTime Prompt

The parameter of type prompt accepts only one answer value (cardinality Single).

<parameters>
    <parameter optional="false" type="prompt" dpId="DP0">
        <id>0</id>
        <name>Enter Open Date:</name>
        <answer constrained="false" type="DateTime">
            <info cardinality="Single">
                <lov refreshable="true" partial="false" hierarchical="false">
                    <values>
                        <value>2011-09-03T17:15:00.000+02:00</value>  <!-- possible values -->
                        <value>2012-09-03T17:15:00.000+02:00</value>
                        <value>2013-09-03T17:15:00.000+02:00</value>
                    </values>
                </lov>
                <values>
                    <value>2011-09-03T17:15:00.000+02:00</value>  <!-- default value -->
                </values>
            </info>
            <values>
                <value>2011-09-03T17:15:00.000+02:00</value> <!-- default value -->
            </values>
        </answer>
    </parameter>
</parameters>

Example

Prompt with Multiple Values

The parameter of type prompt accepts multiple answer values (cardinality Multiple).

<parameters>
    <parameter dpId="DP0" type="prompt" optional="false">
        <id>0</id>
        <technicalName>pmmultiple</technicalName>
        <name>Enter Cityname (multiple)</name>
        <answer type="Text" constrained="true">
            <info cardinality="Multiple">
                <lov refreshable="true" partial="false" hierarchical="false">
                    <id>UNIVERSELOV_DS0.DO22</id>
                    <values>
                        <value>Barcelona</value>  <!-- possible values -->
                        <value>Berlin</value>
                        <value>Copenhagen</value>
                        <value>Firenze</value>
                        <value>London</value>
                        <value>Madrid</value>
                        <value>Marseilles</value>
                        <value>Oslo</value>
                        <value>Paris</value>
                        <value>Pragues</value>
                        <value>Roma</value>
                        <value>Stockholm</value>
                        <value>Stuttgart</value>
                    </values>
                    <columns mappingId="0">
                        <column type="String" id="0">Cityname</column>
                    </columns>
                </lov>
                <values>
                    <value>Barcelona</value>  <!-- default values -->
                    <value>Berlin</value>
                </values>
            </info>
            <values>
                <value>Barcelona</value> <!-- default values -->
                <value>Berlin</value>
            </values>
        </answer>
    </parameter>
</parameters>