Overview
Selects all possible values of a list object.
Information noteThis method applies to list objects (objects with one dimension).
Parameters
| Name | Description | Type |
|---|---|---|
| qPath |
Path to the definition of the object to be selected. For example, /qListObjectDef. This parameter is mandatory. |
String |
| qSoftLock |
Set to true to ignore locks; in that case, locked fields can be selected. The default value is false. This parameter is optional. |
Boolean True/False |
Outputs
{
"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.
Learn more
Did this page help you?
If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!