Schema definition for workflow status.
What this schema does
Defines the object fields used for Workflow Status data exchanged by this API.
Used in endpoints
This schema is used as a response structure in the following endpoints:
GET /v1/workflows/{definitionId}/latest/status(response code(s): 200)GET /v1/workflows/{definitionId}/{version}/status(response code(s): 200)
Fields
| Field | Type | Required | Description |
|---|---|---|---|
| definitionId | string | Yes | Unique identifier for the workflow definition. |
| version | integer | Yes | Version number of the workflow definition. |
| latestRun | object | No | Details for the most recent workflow run, including run status and execution information when available. |
{
"definitionId": "string",
"version": 0,
"latestRun": {
"runId": "string",
"status": "string",
"initiatedAt": "string",
"steps": [
{
"name": "string",
"status": "string",
"type": "string",
"error": "string",
"occurredAt": "string"
}
]
}
}