Sign in
latestOpenAPI 3.1.02026-08-186974431.1 MB

84917af8da36

customFields

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" icon="key">The user must be an admin or have project-manage-config:write permissions.</Check>

post/customfielddefinitions

Headers

Authorizationstring required

Bearer authentication

Request body

namestring required

The name of the custom field definition.

type'text' | 'number' | 'date' | 'datetime' | 'select' | 'coloredSelect' | 'link' | 'boolean' | 'user' | 'client' required

The type of the custom field definition.

ordernumber double nullable

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.

entity'task' | 'project' required

The entity the custom field definition can be linked to.

Response

OK

idstring uuid

The id of the custom field definition.

namestring nullable

The name of the custom field definition.

entity'task' | 'project'

The entity the custom field definition can be linked to.

type'text' | 'number' | 'date' | 'datetime' | 'select' | 'coloredSelect' | 'link' | 'boolean' | 'user' | 'client'

The type of the custom field definition.

createdOnstring date-time

The date this entity was created.

createdBystring uuid

The id of the user who created this entity.

updatedOnstring date-time

The date this entity was last modified.

updatedBystring uuid

The id of the user who last modified this entity.

ordernumber double nullable

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

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