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

WorkflowTransition

WorkflowTransition

One legal edge of a workflow: the move a work item may make from one status to another, with the label the transition button carries.

View as Markdown
Summary view
WorkflowTransitionList, 11 fields. What a list returns by default.
Detail view
WorkflowTransition, 11 fields. The default for a single read and for every write.
Read with
api:read:workflowsandworkflows::read
Write with
api:write:workflowsandworkflows::create

Every status change is checked against these edges, so an edge that does not exist here cannot be walked by the API or in plnnrly. Edges are directed, and duplicates are legal.

Used by

GETList workflow transitions/workflow-transitionsWorkflowTransitionList
POSTCreate a workflow transition/workflow-transitionsWorkflowTransition
GETRead a workflow transition/workflow-transitions/{workflow_transition}WorkflowTransition
PATCHUpdate a workflow transition/workflow-transitions/{workflow_transition}WorkflowTransition

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.

workflow_idinteger

Workflow this edge belongs to. Both statuses belong to the same workflow, and the edge cannot be moved to another one.

from_status_idinteger

Status a work item must currently be in for this edge to apply.

to_status_idinteger

Status the work item moves to. Always different from from_status_id.

namestring≤ 255

Transition label as shown on the status button, e.g. Start progress.

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

Creation timestamp.

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

Last-write timestamp; use for incremental sync.

workflowRef or WorkflowSummary

Workflow this edge belongs to.

from_statusRef or WorkflowStatusSummary

Status the edge leads out of.

to_statusRef or WorkflowStatusSummary

Status the edge leads into.

Variants

WorkflowTransitionList 11 fields

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

The same fields as the detail object.

WorkflowTransitionSummary 3 fields

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

Leaves out: workflow_id, name, created_at, updated_at, workflow, from_status, to_status, links

WorkflowTransitionLinks 1 field

The links object on this resource.

Keys: self