Overview
Makes single selections in dimensions.
Information noteThis method applies to list objects only.
Parameters
| Name | Description | Type |
|---|---|---|
| qPath |
Path to the definition of the object to be selected. For example, /qListObjectDef. This parameter is mandatory. |
String |
| qValues |
Element numbers to select. You can select multiple values; the separator is the comma. This parameter is mandatory. |
Array of Integer |
| qToggleMode |
Set to true to toggle. This parameter is mandatory. |
Boolean True/False |
| qSoftLock |
Set to true to ignore locks; in that case, locked fields can be selected. This parameter is optional. The default value is false. |
Boolean True/False |
Outputs
The following is returned in the output:
{
"jsonrpc": "2.0",
"id": <identifier of the request>,
"result": {
"qSuccess": true/false
},
"change": [
<handle x>,
<handle y>
]
}
The member Change returns the handles of the objects that are updated following the selections.
qSuccess is set to true if the selections are successful and is set to false in the following cases:
- The object contains some invalid fields (fields that are not in the data model),
- The selection applies to a locked field,
- A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.