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

Label

Label

A label: a per-project tag work items are marked with, carrying the colour and the optional icon the backlog chips and the work item detail view show beside its name.

View as Markdown
Summary view
LabelList, 9 fields. What a list returns by default.
Detail view
Label, 9 fields. The default for a single read and for every write.
Read with
api:read:project_managementandproject_management::view_backlog
Write with
api:write:project_managementandproject_management::manage_work_items

Labels belong to one project and are attached to work items from the work-item side.

Used by

GETList labels/labelsLabelList
POSTCreate a label/labelsLabel
GETRead a label/labels/{label}Label
PATCHUpdate a label/labels/{label}Label

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.

project_idinteger

The project this label belongs to. Follow GET /api/v2/projects/{project} for its details; the project is not expandable from here.

namestring≤ 255

Label name as shown on the chip, e.g. Blocked.

colorstring≤ 255

Six-digit hex colour, e.g. #ef4444. Stored verbatim: a row written before the colour picker enforced the format reads back as it is stored.

iconstring or null≤ 255

Icon name, e.g. heroicon-o-tag: not a URL and not markup. Null when the label has no icon.

orderintegerServer-assigned

Display position within the project. Assigned on create as the next position in that project's label order, changed only by dragging in plnnrly, and not writable.

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

Creation timestamp.

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

Last-write timestamp; use for incremental sync.

Variants

LabelList 9 fields

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

The same fields as the detail object.

LabelSummary 3 fields

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

Leaves out: project_id, icon, order, created_at, updated_at, links

LabelLinks 1 field

The links object on this resource.

Keys: self