Query Preference Definitions
Get list of preference definitions
Request
URI
GET
https://{api_host}/cloudapi/1.0.0/definitions/preferences
COPY
Query Parameters
string
filter
Optional
Filter for a query. FIQL format.
string
sortAsc
Optional
Field to use for ascending sort
string
sortDesc
Optional
Field to use for descending sort
integer
page
Required
Page to fetch, zero offset.
integer
pageSize
Required
Results per page to fetch.
Responses
200
OK
Returns PreferenceDefinitions of type(s) application/json;version=39.0
This response body class contains all of the following: Page , InlinePreferenceDefinitions1
{
"resultTotal": 0,
"pageCount": 0,
"page": 0,
"pageSize": 0,
"associations": [
{
"entityId": "string",
"associationId": "string"
}
],
"values": [
{
"id": "string",
"name": "string",
"description": "string",
"classifier": "string",
"dataType": "string",
"constrained": false,
"minValue": "number",
"maxValue": "number",
"defaultValue": "string",
"allowedValues": [
"string"
]
}
]
}
Availability
Added in 32.0
Preferences Operations
GET
Get Preference
GET
Get Preference Definition
GET
Query Preference Definitions
GET
Query Preferences
PUT
Update Preference