Use this endpoint to get the status of a specific export task.
You can use optional query parameter includeProcessDetails to get the start time and duration of each step.
Note: As a best practice, we recommend you check the status of an ongoing process no more than once every 5 seconds. For long running processes it is suggested to check at even longer intervals.
In the response:
- currentStep is the task associated with the specified taskId.
- taskState is the status of the process task.
- progress is a double that is typically 1.0.
- result is a JSON object that indicates whether a failure dump file was created, the objectId, and whether the task succeeded.
- failureDumpAvailable indicates whether this process container or an action within it has a failure dump file.
Note: For a deletion action, failureDumpAvailable is always false.
- nestedResults indicates whether the actions carried out in the process were successful. This contains details in the form of a JSON array, which also contains some debug information when failures occur. Get the failure dump file to view the complete debug information.
- objectID is the identifier of the process task or a task that it includes. For instance, if nestedResults has failureDumpAvailable true, you need the objectID within that section to obtain the related 'dump' file.
- taskID is the ID that you specified in the request.
- duration is the overall processing time.
- startTime is the time when the step started.
Here is a list of each possible taskState:
| Status | Description |
| NOT_STARTED | The task is scheduled to run, but has not started yet. |
| IN_PROGRESS | The task is currently running. |
| COMPLETE | The task has finished running whether successful or not. |
| CANCELLING | The task is currently being canceled. Cancellation is not yet complete. |
| CANCELLED | The task has been canceled and the changes have been rolled back. |
Method and endpoint
GET
/workspaces/{workspaceId}/models/{modelId}/processes/{processId}/tasks/{taskId}
Parameters
| Parameter | Required | Type | Description |
| workspaceId | Yes | string | The workspace ID. Example: 8a8b8c8d8e8f8g8i |
| modelId | Yes | string | The model ID. Example: 75A40874E6B64FA3AE0743278996850F |
| processId | Yes | number | The process ID. Example: 118000000002 |
| taskId | Yes | string | The task ID. Example: 5B882A63354A4B45A21C16F3644C9C1B |
Curl example
curl -X GET /
https://api.anaplan.com/2/0/workspaces/{workspaceId}/models/{modelId}/processes/{processId}/tasks/{taskId} \
-H 'authorization: AnaplanAuthToken {anaplan_auth_token}' \
-H 'Content-Type:application/json'
Response
Response 200 (application/json)
{
"meta":{
"schema":"https://api.anaplan.com//2/0/models/75A40874E6B64FA3AE0743278996850F/objects/task"
},
"status":{
"code":200,
"message":"Success"
},
"task":{
"type":"taskInformation",
"taskId":"2846F8E2FD624F7FA91EC6E2F6E318C0",
"currentStep":"Complete.",
"progress":1,
"result":{
"failureDumpAvailable":false,
"nestedResults":[
{
"failureDumpAvailable":false,
"objectId":"117000000015",
"successful":true
}
],
"objectId":"118000000002",
"successful":true
},
"taskState":"COMPLETE"
}
}
Response 200 (application/json) with includeProcessDetails
{
"meta":{
"schema":"https://api.anaplan.com//2/0/models/75A40874E6B64FA3AE0743278996850F/objects/task"
},
"status":{
"code":200,
"message":"Success"
},
"task":{
"type":"taskInformation",
"taskId":"2846F8E2FD624F7FA91EC6E2F6E318C0",
"currentStep":"Complete.",
"progress":1,
"result":{
"failureDumpAvailable":false,
"nestedResults":[
{
"failureDumpAvailable":false,
"objectId":"117000000015",
"successful":true,
"duration": "1112",
"startTime": "1677624625790"
}
],
"objectId":"118000000002",
"successful":true,
"duration": "868",
"startTime": "1677624626034"
},
"taskState":"COMPLETE"
}
}
