Endpoints for Workflow APIs.
The Workflow APIs enable you to retrieve domain resources programmatically. These APIs support automation and integration with external systems.
The Workflow APIs support the following operations:
- Retrieve a workflow
- Retrieve the latest workflow
- Retrieve the latest workflow runs
- Retrieve the latest workflow schedule
- Retrieve the latest workflow status
- Retrieve workflow runs
- Retrieve workflow schedule
- Retrieve workflow status
| HTTP Method | Operation | Description | Endpoint Path |
|---|---|---|---|
| GET | Retrieve a workflow | Retrieve details for a version of the workflow. | /v1/workflows/{definitionId}/{version} |
| GET | Retrieve the latest workflow | Retrieve details for latest version of the workflow. | /v1/workflows/{definitionId}/latest |
| GET | Retrieve the latest workflow runs | Retrieve the paged run history for the latest version of the workflow. | /v1/workflows/{definitionId}/latest/runs |
| GET | Retrieve the latest workflow schedule | Retrieve the schedule metadata for the latest version of the workflow. | /v1/workflows/{definitionId}/latest/schedule |
| GET | Retrieve the latest workflow status | Retrieve the latest run status for the latest version of the workflow when a run exists. | /v1/workflows/{definitionId}/latest/status |
| GET | Retrieve workflow runs | Retrieve the paged public run history for a version of the workflow. | /v1/workflows/{definitionId}/{version}/runs |
| GET | Retrieve workflow schedule | Retrieve the schedule metadata for a version of the workflow. | /v1/workflows/{definitionId}/{version}/schedule |
| GET | Retrieve workflow status | Retrieve the latest run status for a version of the workflow when a run exists. | /v1/workflows/{definitionId}/{version}/status |
| GET | Retrieve workflows | Retrieve the workflows for the current workspace. | /v1/workflows |
| POST | Trigger the latest workflow | Manually trigger the latest workflow version. | /v1/workflows/{definitionId}/latest |