LOV represents the list of values associated with the parameter. It describes the possible values of the answer.
The <lov> element defines a list of values itself.
<lov hierarchical="Boolean" partial="Boolean" refreshable="Boolean" searchable="Boolean" mandatorySearch="Boolean" path="[[0|1|2,\ second_level_value],[0|1|2,\ third_level_value],[...]]">
Attribute | Type or Value | Description |
---|---|---|
hierarchical | Boolean | Specifies whether the list of values associated with the parameter is hierarchical. |
partial | Boolean | Specifies whether the list of values is displayed entirely. The size of the list of values depends on server settings or universe query limit. |
refreshable | Boolean | Specifies whether the list of values can be refreshed. This attribute can be used in a user interface to allow the refresh of the list of values. |
searchable | Boolean | Specifies whether values of the list of values can be searched. This attribute can be used in a user interface to allow the search on a list of values. |
mandatorySearch | Boolean | Specifies whether values of the list of values are restricted to those filtered
through a search pattern. This attribute reflects the
Force users to filter values before use
option of the default list of values. If
mandatorySearch="true", no value or interval is
returned unless a search pattern <search> is
provided in <query>. See Answer Request Body Schemas. This is an optional attribute that you can use only when searchable="true". |
path | [0|1|2,\ value] | Optional. In the case of hierarchical parameters, specifies the values and types of
the hierarchy, starting with the second level. This attribute
appears in the lov element of the response of the
PUT .../parameters call. The syntax [0|1|2,\ value] describes the data type and the data value of a level.
See example in Example - Responding to a Hierarchical Parameter. |
LOV is made of the following elements if the list of values contains one column:
<lov> <id> <updated> [Intervals|Values] Columns
Element | Type or Value | Description |
---|---|---|
<id> | string | The list of values identifier |
<updated> | DateTime | The date of last update of the list of values |
Intervals | N/A | The element block that describes values as intervals when the number of values is too
large. The first interval is returned by default. The default number
of values in an interval is 50. Values of a context parameter can have a description. <intervals> <interval id="integer"> <value id="integer" description="string" final="Boolean"> |
Values | N/A | The element block that describes the possible values of the list of values. Values of
a context parameter can have a
description.<values> <value id="integer" description="string" final="Boolean"> |
Columns | N/A | The element block that describes the column to be mapped to the
list of values. <column> defines the column
name. Its type attribute is
mandatory.<columns mappingID="integer"> <column id="integer" type="String|Date|Numeric"> |
LOV is made of the following elements if the list of values contains multiple columns:
<lov> <id> <updated> [Intervals_MC|Values_MC] Columns
Element | Type or Value | Description |
---|---|---|
<id> | string | The list of values identifier |
<updated> | DateTime | The date of last update of the list of values |
Intervals_MC | N/A | The element block that describes values as intervals when the number of values is too
large. The first interval is returned by default. An interval can
contain 50
values.<intervals> <interval id="integer"> <cvalue id="integer" final="Boolean"> <column id="integer"> |
Values_MC | N/A | The element block that describes the possible values of the list of values.
<cvalue> defines the values of multiple
columns. <column> defines the column
value.<cvalues> <cvalue id="integer" final="Boolean"> <column id="integer"> |
Columns | N/A | The element block that describes the columns to be mapped to the
list of values. <column> defines the column
name. Its type attribute is mandatory.
mappingID defines the identifier of the column,
of which the value is used as reference to answer the
parameter.<columns mappingID="integer"> <column id="integer" type="String|Date|Numeric"> |
In the case of cascading parameters, the value given to a parameter depends on the answer to a previous parameter.
LOV is made of the following elements:
<lov> <id> <parameters> <id> <id> ...
Under <parameters>, each <id> corresponds to the identifier of a parameter, on which depend the values of the current parameter.