JSON API » fields » fields/allowed/delete

Deletes 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 delete.Yes

Responses

CodeDescription
204Success.
401The authentication details provided are invalid.
402Your role does not allow this.
404The allowed value does not exist.

Data returned

No data is returned.

Example: With required parameters

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

{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }

Change history

VersionChanges
4.0Function added.