...
GET taskrunstatus (2017.02)
Track the status of a workflow using the taskRunIdtasId which is provided when running a workflow with the runTask endpoint.
Request parameters
- taskId (string, required): task Id of a workflow.
maxWaitMillis (integer) time in milliseconds to wait for response
- documentVersion (string, 1.9 or up): Since 2022.02. File format version (optional). For example: 1.29
- documentFormat (string): PI_JSON. Since 2022.02. If not specified, plain text is assumed.
Response
Status of the workflow task. Possible response codes are:
I = Invalid,P = Pending,T = Terminated,R = running,F = Failed,C = Completed fully successful,D = Completed partly successful,A = Approved,B = Approved partly successfulnull= No status available (produces when method call times-out)
Example request
| Code Block |
|---|
curl "localhost:8080/FewsWebServices/rest/fewspiservice/v1/taskrunstatus?taskId=1_0" |
Example response
| Code Block |
|---|
C |
Since 2022.02 the taskrun status response supports PI_JSON as well. Since 2024.01 the taskRunId is available as well. For example:
| Code Block |
|---|
{
"version" : "1.29",
"code" : "C",
"description" : "Completed fully successful",
"taskRunId" : "1234"
} |
...