WeaveKit Docs

Workflow status for a record

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`).

GET/api/objects/{name}/{id}/workflow

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).

Authorization

bearerAuth
AuthorizationBearer <token>

API key present in auth.source (or resolved by an AuthResolver).

In: header

Path Parameters

name*string

Object name from objects/<name>/schema.json.

id*string

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

curl -X GET "https://example.com/api/objects/string/string/workflow"
{  "state": "draft",  "node": "string",  "approval": "string",  "actions": [    "string"  ],  "workitems": [    {      "id": "string",      "nodeId": "string",      "kind": "string",      "state": "string"    }  ]}