Schema definition for workflow schedule.
What this schema does
Defines the object fields used for workflow schedule 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/schedule(response code(s): 200)GET /v1/workflows/{definitionId}/{version}/schedule(response code(s): 200)
Fields
| Field | Type | Required | Description |
|---|---|---|---|
| expression | string | Yes | Schedule expression that defines when the workflow is triggered (for example, a daily or recurring schedule). |
| status | string | Yes | Current state of the workflow schedule (for example, Enabled or Disabled). |
| nextRunAt | string (date-time) | No | Date and time when the workflow is next scheduled to run. |
| lastRunAt | string (date-time) | No | Date and time when the workflow was last executed. |
| lastRunStatus | string | No | Status of the most recent workflow run. |
| lastRunId | string | No | Unique identifier of the most recent workflow run. |
{
"expression": "string",
"status": "string",
"nextRunAt": "string",
"lastRunAt": "string",
"lastRunStatus": "string",
"lastRunId": "string"
}