plnnrlydevelopers

Deze referentie is alleen in het Engels. Naar het Nederlandse REST API-overzicht

Diese Referenz gibt es nur auf Englisch. Zur deutschen REST-API-Übersicht

Cette référence existe uniquement en anglais. Aller à la présentation de l'API REST en français

Esta referencia solo está en inglés. Ir a la introducción de la API REST en español

WorkType

WorkType

A work-item type: the organisation-wide categories work items are filed under (bug, task, story, …), carrying the colour and icon the backlog, board and Gantt render beside them.

View as Markdown
Summary view
WorkTypeList, 8 fields. What a list returns by default.
Detail view
WorkType, 8 fields. The default for a single read and for every write.
Read with
api:read:work_typesandwork_types::read
Write with
api:write:work_typesandwork_types::create

A type still used by work items cannot be deleted.

Used by

GETList work types/work-typesWorkTypeList
POSTCreate a work type/work-typesWorkType
GETRead a work type/work-types/{work_type}WorkType
PATCHUpdate a work type/work-types/{work_type}WorkType

Fields

Detail only
Only in the detail view.
Only with include
Only when you ask for it with include.
Server-assigned
Set by plnnrly, never by a request.
idinteger

Unique identifier.

namestring≤ 255

Work-type name as shown in the UI, e.g. Bug.

colorstring≤ 255

Six-digit hex colour, e.g. #6b7280. A stored value that is not six-digit hex reads back as #6b7280, so writing this field back unchanged replaces the malformed original.

iconstring≤ 255

Icon name, e.g. heroicon-o-rectangle-stack: not a URL and not markup.

orderintegerServer-assigned

Display position; set by dragging in plnnrly and not writable. API-created types are created at 0 and fall back to the id tiebreaker.

created_attimestamp (YYYY-MM-DDThh:mm:ssZ)

Creation timestamp.

updated_attimestamp (YYYY-MM-DDThh:mm:ssZ)

Last-write timestamp; use for incremental sync.

Variants

WorkTypeList 8 fields

What a collection returns, and what ?view=summary returns on a single record.

The same fields as the detail object.

WorkTypeSummary 4 fields

The embedded form: what you get when another resource carries this one and you did not include it.

Leaves out: order, created_at, updated_at, links

WorkTypeLinks 1 field

The links object on this resource.

Keys: self