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.
Name | Type | Description | Required | Default value |
---|---|---|---|---|
auth_username | String | Authentication username. | Yes | |
auth_password | String | Authentication password. | Yes | |
field | Integer | ID of field. | Yes | |
value | String | Allowed value to get. | Yes |
Responses
Code | Description |
---|---|
200 | Success. |
401 | The authentication details provided are invalid. |
402 | Your role does not allow this. |
404 | The 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
Version | Changes |
---|---|
4.0 | Function added. |