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

Subtask

Subtask

A checklist subtask on a work item: a title, an optional rich-text note and a ticked-off flag, held in the work item's own checklist order.

View as Markdown
Summary view
SubtaskList, 9 fields. What a list returns by default.
Detail view
Subtask, 10 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

Subtasks only mean anything under the work item they belong to, so they are listed and created through that work item and read, edited and deleted on their own flat path. There is no organisation-wide collection of subtasks and no filter[work_item_id].

Used by

GETRead a subtask/subtasks/{subtask}Subtask
PATCHUpdate a subtask/subtasks/{subtask}Subtask
GETList a work item's subtasks/work-items/{work_item}/subtasksSubtaskList
POSTAdd a subtask to a work item/work-items/{work_item}/subtasksSubtask

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.

work_item_idintegerServer-assigned

The work item whose checklist this subtask belongs to. Taken from the path on create and not writable.

titlestring≤ 255

Subtask title, as shown on the checklist row. This is the field ?q= searches.

descriptionhtml or nullDetail only

Optional note on the subtask. HTML from the rich editor, sanitised on read and on write. Null when the subtask is just a title.

is_resolvedboolean

Whether the subtask is ticked off.

orderintegerServer-assigned

Position in the work item's checklist. Assigned on create as the next position in that checklist, 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.

work_itemRef or WorkItemSummary

The work item this subtask hangs off.

Variants

SubtaskList 9 fields

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

Leaves out: description

SubtaskSummary 3 fields

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

Leaves out: work_item_id, description, order, created_at, updated_at, work_item, links

SubtaskLinks 1 field

The links object on this resource.

Keys: self