Skip to navigation
API v1 ReferenceType of Work

Archives or unarchives the type of work.

Archives or unarchives the type of work. Archived types remain available for existing time entries.

Required Permissions
The user must be an admin or have workspace-manage-config:write permissions.

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 archived form payload.
isArchivedbooleanOptional
Flags the entity as archived.

Response

OK
idstringOptionalformat: "uuid"
The id of the task type.
namestring or nullOptional
The name of the task type.
descriptionstring or nullOptional

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

iconstring or nullOptional
The icon associated with this task type.
isArchivedbooleanOptional
Whether the type of work has been archived.
createdOnstringOptionalformat: "date-time"
The date this entity was created.
createdBystringOptionalformat: "uuid"
The id of the user who created this entity.
updatedOnstringOptionalformat: "date-time"
The date this entity was last modified.
updatedBystringOptionalformat: "uuid"
The id of the user who last modified this entity.

Errors

400
Bad Request Error
404
Not Found Error