Parameter Response Body Schemas

Response Body Schemas (XML)

(GET and PUT .../parameters)

This schema contains the parameters and their properties, such as the expected answers.

Note See examples in Getting the List of Parameters (BI Semantic Layer RESTful Web Service SDK) and Getting the Refresh Parameters (Web Intelligence RESTful Web Service SDK).
<parameters>
    <parameter type="context|prompt|sapVariable" optional="Boolean" dpId="string">
        <id>
        <technicalName>
        <name>
        <description>
        <answer type="Text|Numeric|Date|Unknown" constrained="Boolean">   
            <info cardinality="Single|Multiple|Interval" keepLastValues="Boolean">
                LOV
                [DefaultValues|PreviousValues]
                ContextIncompatibilities
            Values
Element Type or Value Description
<id> integer Parameter identifier. The web service generates it automatically.
<technicalName> string Optional technical name of the parameter
<name> string Prompt question in the user locale
<description> string Optional description of the parameter
<answer> N/A The expected answer
Attribute Type or Value Description
type context|prompt|sapVariable The parameter type (context, @Prompt, object parameter, or SAP variable)
optional Boolean Specifies whether the parameter is optional (false if type="context")
dpId string A mandatory attribute that defines the data provider identifier used for this parameter. Only used in the Web Intelligence RESTful Web Service SDK.
Element Description
<info> Contains:
  • The list of values associated with the parameter (LOV)
  • The DefaultValues or PreviousValues
  • The incompatible context values (ContextIncompatibilities)

See the next sections for more information.

Values The values associated with the parameter.

In the GET .../parameters call result, they are either DefaultValues or PreviousValues.

Remember PreviousValues are only returned by the Web Intelligence RESTful Web Service SDK.
Attribute Type or Value Description
type Text|Numeric|Date|DateTime|Unknown The answer type. The unknown type is not supposed to be returned.
constrained Boolean Defines if the user can type a new value for the parameter (false) or if the user must select only the values from the associated list of values (true).
Attribute Type or Value Description
cardinality Single|Multiple|Interval The number of values expected by the parameter (one value, several values, or two values).
keepLastValues Boolean Indicates whether the parameter of type prompt keeps the previous answered values.
Remember When working with the BI Semantic Layer RESTful web service, you must implement the storage of the previous answered values, because the web service does not store them. When working with the Web Intelligence RESTful web service, the values are kept in the Web Intelligence document.