API v1 ReferenceCustom Fields

Creates a new custom field definition.

Creates a new custom field definition. This custom field definition can then be linked to project templates and to tasks. <Check title="Required Permissions">The user must be an admin or have `project-manage-config:write` permissions.</Check>

Request

The model containing the details for creating a new custom field definition.
namestringRequired>=1 character<=255 characters
The name of the custom field definition.
typeenumRequired
The type of the custom field definition.
entityenumRequired
The entity the custom field definition can be linked to.
Allowed values:
selectionOptionslist of objects or nullOptional
The selection options for the custom field definition. Can only be used if the type is 'select'.
orderdouble or nullOptional

The order of the custom field definition. This value is only used (and required) if the entity is ‘project’, as the project custom field definitions are globally ordered. To set the order for task custom field definitions, use the endpoint to update the order of a custom field definition for a project/project template.

Response

OK
idstring or nullformat: "uuid"
The id of the custom field definition.
namestring or null
The name of the custom field definition.
entityenum or null
The entity the custom field definition can be linked to.
Allowed values:
typeenum or null
The type of the custom field definition.
createdOnstring or nullformat: "date-time"
The date this entity was created.
createdBystring or nullformat: "uuid"
The id of the user who created this entity.
updatedOnstring or nullformat: "date-time"
The date this entity was last modified.
updatedBystring or nullformat: "uuid"
The id of the user who last modified this entity.
orderdouble or null
If it's a project custom field, it's the global order of the custom field definition. Otherwise, it's the order of the custom field definition within a project template or a project.
isExternalboolean or null

True if this entity is coming from an external workspace (awork Connect).