Get Preference Definition

Get Preference Definition

Get specified preference definition.

Request
URI
GET
https://{api_host}/cloudapi/1.0.0/definitions/preferences/{preferenceDefinitionId}
COPY
Path Parameters
string
preferenceDefinitionId
Required

preferenceDefinitionId

string
preferenceDefinitionId
Required

preferenceDefinitionId

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns PreferenceDefinition of type(s) application/json;version=39.0 
{
    "id": "string",
    "name": "string",
    "description": "string",
    "classifier": "string",
    "dataType": "string",
    "constrained": false,
    "minValue": "number",
    "maxValue": "number",
    "defaultValue": "string",
    "allowedValues": [
        "string"
    ]
}
string
id
Optional

UUID for preference definition. This is immutable.

string
name
Required

Display name.

string
description
Optional

Description for user preference

string
classifier
Required

unique indetifier for this preference definition. It should be of type : . e.g vrops:myworkflow. This is immutable.

string
dataType
Required

user preference value data type. This is immutable.

Possible values are : BOOLEAN, INTEGER, STRING,
boolean
constrained
Required

true if user preference is selected from list of values (dataType should be number or string), false otherwise. This is immutable.

number
minValue
Optional

minimum value for user preference. Only valid if user preference type is number. This is immutable.

number
maxValue
Optional

maximum value for user preference. Only valid if user preference type is number. This is immutable.

string
defaultValue
Required

default value for user preference.

array of string
allowedValues
Optional

array of allowed values to select from when constrained is true.. This is immutable after creation.


404

Not Found

Operation doesn't return any data structure

Availability
Added in 32.0
On This Page
Preferences Operations
GET
Get Preference
GET
Get Preference Definition
GET
Query Preference Definitions
GET
Query Preferences
PUT
Update Preference