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

WorkItemLink

WorkItemLink

A directed link between two work items (blocks, duplicates, relates_to and four more), the rows the linked items section in plnnrly is built from.

View as Markdown
Summary view
WorkItemLinkList, 12 fields. What a list returns by default.
Detail view
WorkItemLink, 12 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

A link is read relative to the work item you asked about: one row is "blocks ACM-9" from one end and "is blocked by ACM-4" from the other, which is what direction and relationship carry. There is no PATCH: the only mutable property of a link is which two items it joins, so re-linking is a DELETE plus a POST. Deleting either work item deletes the link with it.

Used by

GETRead a work item link/work-item-links/{work_item_link}WorkItemLink
GETList a work item's links/work-items/{work_item}/linksWorkItemLinkList
POSTLink a work item to another/work-items/{work_item}/linksWorkItemLink

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.

source_work_item_idinteger

Work item the link points away from. On a link created through POST work-items/{work_item}/links this is always the work item named in the path.

target_work_item_idinteger

Work item the link points at. Always in the same project as the source.

created_byinteger or nullServer-assigned

User who created the link, or null where that account has since been deleted. Resolve it with GET /api/v2/users/{user}; it is not includable.

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

Creation timestamp.

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

Last-write timestamp; use for incremental sync.

directionstring

Which way this link points relative to the work item you asked about: forward when that item is the source, inverse when it is the target. On the flat GET work-item-links/{work_item_link} there is no work item in the path, so the link is read on its own terms and this is always forward.

relationshipstring

The relationship in words, from the point of view of the work item you asked about: blocks from the source end, is blocked by from the target end. Always in English: the API pins the locale.

source_work_itemRef or WorkItemSummary

Work item the link points away from.

target_work_itemRef or WorkItemSummary

Work item the link points at.

Variants

WorkItemLinkList 12 fields

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

The same fields as the detail object.

WorkItemLinkSummary 3 fields

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

Leaves out: link_type, created_by, created_at, updated_at, direction, relationship, source_work_item, target_work_item, links

WorkItemLinkLinks 1 field

The links object on this resource.

Keys: self