JSON API » fields » fields/allowed/get

Gets the fields of a custom field allowed value. Only used for custom fields with type "allowed".

Input parameters

Requires authentication and the system role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
fieldIntegerID of field.Yes
valueStringAllowed value to get.Yes

Responses

CodeDescription
200Success.
401The authentication details provided are invalid.
402Your role does not allow this.
404The custom field does not exist.

Data returned

Fields of allowed value.

Example: With required parameters

http://enswitch.example.com/api/json/fields/allowed/get/?auth_username=user;auth_password=password;field=1;value=example1

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "field":1, "value":"example1", "display":"Example 1" } }

Change history

VersionChanges
4.0Function added.