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

Workflow

Workflow

A workflow: the named set of statuses a work item moves through, plus the transitions allowed between them.

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

A project points at one workflow. Statuses and transitions are managed as their own collections: a workflow is created empty.

Used by

GETList workflows/workflowsWorkflowList
POSTCreate a workflow/workflowsWorkflow
GETRead a workflow/workflows/{workflow}Workflow
PATCHUpdate a workflow/workflows/{workflow}Workflow

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

Workflow name as shown in the UI, e.g. Standard.

orderintegerServer-assigned

Display position; set by dragging in plnnrly and not writable. API-created workflows 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.

statuses_countinteger≥ 0

Number of statuses in this workflow.

Variants

WorkflowList 7 fields

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

The same fields as the detail object.

WorkflowSummary 2 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, statuses_count, links

WorkflowLinks 2 fields

The links object on this resource.

Keys: self, statuses