[{"label":"Latest (v36.3)","version":"latest"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director

Get Preference Definition

Description

Get specified preference definition.

Request

Request

URL

URL


get
https://{api_host}/cloudapi/1.0.0/definitions/preferences/{preferenceDefinitionId}
Copy

Path Parameters

Path Parameters

string
preferenceDefinitionId Required

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns PreferenceDefinition of type(s) application/json;version=36.3
{
	"allowedValues": [
		"string"
	],
	"classifier": "string",
	"constrained": false,
	"dataType": "BOOLEAN",
	"defaultValue": "string",
	"description": "string",
	"id": "string",
	"maxValue": 0,
	"minValue": 0,
	"name": "string"
}
string
classifier Required

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


boolean
constrained Required

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


string
dataType Required

user preference value data type. This is immutable.

Possible values are: BOOLEANINTEGERSTRING


string
defaultValue Required

string
name Required

Display name.


array of string
allowedValues Optional

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


string
description Optional

Description for user preference


string
id Optional

UUID for preference definition. This is immutable.


number
maxValue Optional

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


number
minValue Optional

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

Errors

Errors

404

Not Found

Code Samples

Code Samples

cURL Command

curl https://{api_host}/cloudapi/1.0.0/definitions/preferences/{preferenceDefinitionId}


[{"label":"Latest (v36.3)","version":"latest"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director
Feedback

Was this page helpful?