Use this call to get the status of an ongoing deletion task.

Note: You can cancel an ongoing monitoring task if you make the same call using the DELETE verb instead of the GET one.

In the response:

  • currentStep is the task associated with the specified taskID.
  • taskState is the status of that deletion task.
  • progress is a double that is typically 1.0.
  • result is a JSON object that indicates the object ID, and whether the task succeeded.

Note: For a deletion action, failureDumpAvailable is always false.

  • taskID is the ID that you specified in the request.

Here's a list of each possible taskState:

StatusDescription
NOT_STARTEDThe task is scheduled to run, but has not started yet.
IN_PROGRESSThe task is currently running.
COMPLETEThe task has finished running whether successful or not.
CANCELLINGThe task is currently being canceled. Cancellation is not yet complete.
CANCELLEDThe task has been canceled and the changes have been rolled back.

Method and endpoint

GET

/workspaces/{workspaceId}/models/{modelId}/actions/{actionId}/tasks/{taskId}

Parameters

ParameterDescription
workspaceId
  • Required
  • Type: string
  • Description: The workspace ID
  • Example: 8a8b8c8d8e8f8g8i
modelId
  • Required
  • Type: string
  • Description: The model ID
  • Example: 75A40874E6B64FA3AE0743278996850F
actionId
  • Required
  • Type: number
  • Description: The ID for the Delete action.
  • Example: 117000000019
taskId
  • Required
  • Type: string
  • Description: The ID for the Delete task.
  • Example: 0690AA1C761F48549C3442A02F91D962

Curl example

curl -X GET \
https://api.anaplan.com/2/0/workspaces/{workspaceId}/models/{modelId}/actions/{actionId}/tasks/{taskId} \
-H 'authorization: AnaplanAuthToken {anaplan_auth_token}' \
-H 'Content-Type:application/json'

Response

Response 200 (application/json)

{
   "task":{
      "type":"taskInformation",
      "taskId":"0690AA1C761F48549C3442A02F91D962",
      "currentStep":"Complete.",
      "progress":1,
      "result":{
         "failureDumpAvailable":false,
         "objectId":"117000000019",
         "successful":true
      },
      "taskState":"COMPLETE"
   }
}