customFields

Creates a custom field definition.

Changed on

Creates a custom field definition that can be linked to project templates, projects, or tasks according to its entity type.

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

post/customfielddefinitions

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/customfielddefinitions
  • Auth: HTTP bearer

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).

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 PostCustomFieldDefinition removed and replaced with customFields_PostCustomFieldDefinition