Workflow Step Run

The workflow step run resource.

Basehttps://rest.carbon.ms/workflowStepRun

GET/workflowStepRun

List workflow step runs

Retrieve a paginated list of workflow step runs. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GEThttps://rest.carbon.ms/workflowStepRun

curl --request GET \
  --url 'https://rest.carbon.ms/workflowStepRun?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

[
  {
    "id": "abc123def456",
    "companyId": "xyz789",
    "runId": "xyz789",
    "sequence": 0,
    "nodeId": "xyz789",
    "nodeType": "string",
    "itemKey": "string",
    "status": "string"
  }
]

GET/workflowStepRun

Retrieve a workflow step run

Fetch a single workflow step run by filtering on `id`.

Query parameters

idstring

Match on the workflow step run's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/workflowStepRun

curl --request GET \
  --url 'https://rest.carbon.ms/workflowStepRun?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "runId": "xyz789",
  "sequence": 0,
  "nodeId": "xyz789",
  "nodeType": "string",
  "itemKey": "string",
  "status": "string"
}

POST/workflowStepRun

Create a workflow step run

Create a new workflow step run.

Body parameters

runIdstringrequired

sequencenumberrequired

nodeIdstringrequired

nodeTypestringrequired

itemKeystringrequired

statusstringrequired

statusReasonstring

inputobject

outputobject

branchTakenstring

startedAttimestamp

completedAttimestamp

durationMsnumber

errorstring

compactedAttimestamp

detailobject

Diagnostics only (per-clause condition evaluation). Never node data - that is "output".

POSThttps://rest.carbon.ms/workflowStepRun

curl --request POST \
  --url https://rest.carbon.ms/workflowStepRun \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"runId":"xyz789","sequence":0,"nodeId":"xyz789","nodeType":"string","itemKey":"string","status":"string"}'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "runId": "xyz789",
  "sequence": 0,
  "nodeId": "xyz789",
  "nodeType": "string",
  "itemKey": "string",
  "status": "string"
}

PATCH/workflowStepRun

Update a workflow step run

Update an existing workflow step run, matched on `id`.

Body parameters

runIdstringrequired

sequencenumberrequired

nodeIdstringrequired

nodeTypestringrequired

itemKeystringrequired

statusstringrequired

statusReasonstring

inputobject

outputobject

branchTakenstring

startedAttimestamp

completedAttimestamp

durationMsnumber

errorstring

compactedAttimestamp

detailobject

Diagnostics only (per-clause condition evaluation). Never node data - that is "output".

PATCHhttps://rest.carbon.ms/workflowStepRun

curl --request PATCH \
  --url 'https://rest.carbon.ms/workflowStepRun?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"runId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "runId": "xyz789",
  "sequence": 0,
  "nodeId": "xyz789",
  "nodeType": "string",
  "itemKey": "string",
  "status": "string"
}

DELETE/workflowStepRun

Delete a workflow step run

Delete a workflow step run, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the workflow step run to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/workflowStepRun

curl --request DELETE \
  --url 'https://rest.carbon.ms/workflowStepRun?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

204 No Content