customFields

Creates an option for a custom field.

Changed on

Creates a selection option for the specified custom field definition and places it at the requested order.

<Check title="Required Permissions" icon="key">The user must be an admin or have project-manage-config:write permissions.</Check>

post/customfielddefinitions/{customFieldDefinitionId}/selectionoptions

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/customfielddefinitions/{customFieldDefinitionId}/selectionoptions
  • Auth: HTTP bearer

Path parameters

customFieldDefinitionIdstring uuid required

The id of the custom field definition to add a selection option to.

Request body

valuestring required

The selection value which can be used in a select custom field.

color'red' | 'orange' | 'yellow' | 'green' | 'cyan' | 'blue' | 'indigo' | 'purple' | 'steel'

The color of the selection option.

ordernumber double required

The order of the custom field selection option.

Response

OK

idstring uuid

The id of the custom field selection option.

valuestring required

The selection value which can be later used in a select custom field.

color'red' | 'orange' | 'yellow' | 'green' | 'cyan' | 'blue' | 'indigo' | 'purple' | 'steel'

The color of the selection option.

ordernumber double

The order of the custom field selection option.

Changes

  • 1556e0487867Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e46cf415581Revision changes
    • info

      api operation id PostCustomFieldDefinitionSelectionOptionsByCustomFieldDefinitionId removed and replaced with customFields_PostCustomFieldDefinitionSelectionOptionsByCustomFieldDefinitionId