Get a workflow
Get a workflow.
Request syntax
GET /workflows/${WORKFLOW_ID} HTTP/1.1
Host: api.simworkflow.com
Authorization: Bearer ${PERSONAL_ACCESS_TOKEN}
Request headers
|
Authorization |
|
|---|
Response syntax
HTTP/1.1 200 OK
{
"id": String,
"organizationId": String,
"workflowDefinitionId": String,
"workflowDefinitionVersion": Integer,
"sequenceNumber": Long,
"input": JSON,
"output": JSON,
"status": String,
"failedReason": String,
"startedTime": Timestamp,
"endedTime": Timestamp
}
Response elements
If the action is successful, the service sends back an HTTP 200 response.
The response returns the body contains the workflow JSON.
Errors
See also general errors.
cURL example: get a workflow
GET /workflows/0q5DuIecMLn74UumTnDJFr
curl \
--request "GET" \
--header "Authorization: Bearer ${PERSONAL_ACCESS_TOKEN}" \
--url "https://api.simworkflow.com/workflows/0q5DuIecMLn74UumTnDJFr"
RESPONSE
HTTP/1.1 200 OK
{
"id": "0q5DuIecMLn74UumTnDJFr",
"organizationId": "0y4OfYajRyqc2RNueODHww",
"workflowDefinitionId": "7RXzkCER4ERYGpMzvrfy1D",
"workflowDefinitionVersion": 2,
"sequenceNumber": 19,
"input": {
"swf:workflowId": "0q5DuIecMLn74UumTnDJFr",
"swf:sequenceNumber": 19,
"swf:workflowDefinitionId": "7RXzkCER4ERYGpMzvrfy1D",
"swf:workflowDefinitionVersion": 2
},
"output": {},
"status": "Running",
"failedReason": null,
"startedTime": "2023-11-02T23:12:49.481Z",
"endedTime": null
}