Query Preference Definitions

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
Constraints: minimum: 1 default: 1

Page to fetch, zero offset.

integer
pageSize
Required
Constraints: minimum: 0 maximum: 128 default: 25

Results per page to fetch.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns PreferenceDefinitions of type(s) application/json;version=40.0
This response body class contains all of the following: InlinePreferenceDefinitions0 , 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"
            ]
        }
    ]
}

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/cloudapi/1.0.0/definitions/preferences?page=value&pageSize=v
Availability
Added in 32.0
On This Page
Preferences Operations
GET
Query Preference Definitions
GET
Get Preference Definition
GET
Query Preferences
Deprecated
GET
Query Preferences Vcf
GET
Get Preference
PUT
Update Preference
GET
Query User Preferences
GET
Get User Preference
PUT
Update User Preference