Workflow step
Included from Basic tier
A workflow step is one node of a workflow run's step tree: a noop, a
change step spawning a change, a wait step holding for a human or an
approval, or a workflow step nesting another run. The rows are created by
the run itself as its frozen tree executes; the API's writes are the gate
verbs that progress a waiting step — approve (satisfies an approval gate),
continue (a plain wait; an approval-gated wait refuses it) and reject
(fails the run's gate). Served by the v2 WorkflowStepService
(ApproveWorkflowStep, ContinueWorkflowStep, RejectWorkflowStep,
GetWorkflowStep, ListWorkflowSteps — a run's rows whole, in tree
order), authorised by read on the owning run's project, 404-on-deny.
WorkflowStep
WorkflowStep is one workflow step row. The STI type varies (workflow_noop_step, workflow_change_step, workflow_wait_step, workflow_workflow_step) and each type carries its own attribute set, so the per-type payload travels as a JSON document beside the shared fields.
| Field | Type | Meaning |
|---|---|---|
attributes_json | string | The step's full per-type attribute document as JSON text. |
change_id | string | The spawned change's id (workflow_change_step only; "" otherwise). |
child_ids | array of string | Child step ids, in tree order. |
child_workflow_run_id | string | The nested run's id (workflow_workflow_step only; "" otherwise). |
id | string | The record's identity. |
status_code | string | The serialized status code (pending, waiting, success, …) — the same vocabulary v1 serves. |
type | string | The step's type: workflow_noop_step, workflow_change_step, workflow_wait_step or workflow_workflow_step. |
workflow_run_id | string | The owning workflow run's id. |
Related pages
opschain docs resources/workflow_run— the owning run and its step tree.opschain docs resources/workflow— the declaration the tree froze from.opschain docs resources/step— the change-side step rows a change step spawns.