Admin override (jump to a node or terminate)
Admin-only (`admin` role). Body `{ node }` jumps the record to that node; `{ state: 'canceled' | 'finished' }` terminates it.
/api/objects/{name}/{id}/workflowAdmin-only (admin role). Body { node } jumps the record to that node; { state: 'canceled' | 'finished' } terminates it.
Authorization
bearerAuth API key present in auth.source (or resolved by an AuthResolver).
In: header
Path Parameters
Object name from objects/<name>/schema.json.
Record id — the record_key encoding of the (possibly composite) primary key; returned as weave_id.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/api/objects/string/string/workflow"{ "state": "string", "nodeId": "string"}Workflow status for a record GET
Returns the record's workflow instance state, current node, the actions available to the caller, and the caller's open workitems. Requires the object to declare `objects/<name>/workflow.json` (otherwise `404`).
Run a workflow action POST
Runs `submit` | `approve` | `reject` | `withdraw` | `cancel` | `forward`. RBAC-scoped, workitem-gated, atomic and audited. `forward` takes `{ to: { userId } }`; `approve`/`reject`/`withdraw` take `{ comment }`.