API v1 ReferenceType of Work

Changes the properties of an existing type of work.

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

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

typeOfWorkIdstringRequiredformat: "uuid"
The id of the type of work.

Request

The type Of Work form payload.
namestringRequired>=1 character
The names of the type of work.
descriptionstring or nullOptional
A short description of the type of work.
iconstring or nullOptional
The icon associated with this task type.

Response

OK
idstringformat: "uuid"
The id of the task type.
namestring or null
The name of the task type.
descriptionstring or null

A short (max. 140 characters) description of the task type.

iconstring or null
The icon associated with this task type.
isArchivedboolean
Whether the type of work has been archived.
createdOnstringformat: "date-time"
The date this entity was created.
createdBystringformat: "uuid"
The id of the user who created this entity.
updatedOnstringformat: "date-time"
The date this entity was last modified.
updatedBystringformat: "uuid"
The id of the user who last modified this entity.

Errors

400
Bad Request Error
404
Not Found Error