Answer Request Body Schemas

Request Body Schemas (XML)

(PUT .../parameters)

This schema contains the actual answers to pass to contexts or prompts, and the query of a list of values for the parameters that remain to be answered.

<parameters>
    <parameter>
        <id>
        <answer type="Text|Numeric|Date|Unknown" constrained="Boolean">
            <info>
            <values>
                <value path="[0|1|2,\ value]" id="integer">
<info>
    <lov> 
        <query intervalId="integer" intervalSize="Integer|-1|Unlimited|Server" refresh="Boolean"> 
            <sort order="Boolean"/>
            <search>
            <path>  
                <value id="integer" type="String|Date|Numeric">
Parameter
Element Type or Value Description
<id> integer Parameter identifier
<answer> N/A The actual answer
Answer
Element Description
<info>
Contains one of the following:
  • The possible values of the list of values. See its description in Lists of Values.
  • The query used to retrieve a list of values for unanswered parameters. The query can specify how values will be returned, and/or refreshed if the list of values allows it.
Remember

Not mandatory in the request bodies.

<values> The list of actual values expressed as a sequence of <value> elements. Is ignored by the service in the request bodies.
Values
Element Type or Value Description
<value> string An actual value

Attributes:

  • id: Defines the context identifier or the value index. Mandatory if the value contains an answer to a context or if the prompt is index-aware.
  • path: [[0|1|2,\ second_level_value],[0|1|2,\ third_level_value],[...]] Optional. In the case of hierarchical parameters, specifies the values and types of the hierarchy, starting with the second level. The call needs this information to reach the answer value.

    The syntax [0|1|2,\ value] describes the data type and the data value of a level.

    • 0 represents a string
    • 1 represents a date
    • 2 represents a number

    You can also use String, Date, or Numeric explicitely instead of numbers.

    See examples in Example - Responding to a Hierarchical Parameter and Example - Refreshing a Document with a Hierarchical Parameter.

Query
Attribute Type or Value Description
intervalId integer The index of the interval that should be returned. If not specified,the first interval is returned. An error is returned if this index is out of range (depending of values count).
intervalSize integer|-1|Unlimited|Server Specifies the number of values in the interval to return. If not specified, 50 is used. Possible values are:
  • A strictly positive integer
  • -1 or Unlimited indicates the whole list of values is returned
  • Server indicates that the Information Engine Service property List of Values Batch size (entries) of the CMC defines the number of values to return.
refresh Boolean Specifies whether the list of values is refreshed. Optional. An error is returned if the list of values does not allow refreshing.
Element Type or Value Description
<sort> Boolean Specifies whether the list of values must be returned sorted. Optional.

Attribute: order (Ascending|Descending|None)

<search> string Optional. Defines a search pattern in the list of values as a string. The following wildcard characters may be used in the pattern string: ? for zero or one character, and * for zero or n characters. For example, M?Gregor yields to the value McGregor, and M*Gregor to the values McGregor and MacGregor.
<path> N/A Optional. In the case of a hierarchical parameter, it specifies the intermediate answer value. It also specifies the node for which the list of values is requested. This path is expressed as a sequence of <value> elements.

See examples in Example - Responding to a Hierarchical Parameter and Example - Refreshing a Document with a Hierarchical Parameter.

Query Path
Element Type or Value Description
<value> string The value for a node of the path.

Attributes:

  • id: defines the context identifier or the value index. Mandatory if the value contains an answer to a context or if the prompt is index-aware.
  • type: The value type (String|Date|Numeric). Default is String.