1. Data integration
  2. Anaplan API Guide and Reference
  3. Use the bulk APIs
  4. Perform a process action
  5. Get the status of the process task

Returns the status of the process you specify, such as whether it is complete, and, if the process contains one or more imports, whether there are one or more import dump files with information about any rows that failed during import (failureDumpAvailable).

The response includes:

Response valueDescription
currentStepThe task associated with the specified taskID.
taskStateThe status of the process task.  Possible values are:
NOT_STARTED - Scheduled but not started.
IN_PROGRESS - Currently running.
COMPLETE - Done, either successfully or not.
CANCELLING - Cancellation has begun but is not yet complete.
CANCELLED - Cancellation is complete and any changes are rolled back.
progressThe percentage of how much of the task is complete.  Values range from 0.0 (not started) to 1.0 (complete).
failureDumpAvailableIf true, there is a dump file available.
nestedResultsIndicates 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.
objectIDThe identifier of the process task or the task that it includes. 

Method and endpoint

https://api.anaplan.com/2/0/workspaces/{workspaceID}/models/{modelID}processes/{processID}/tasks/{taskID}

GET

Parameters

ParameterDescription
AnaplanAuthToken:{token}Your Anaplan authentication token value.
workspaceIDThe workspace ID
modelIDThe model ID
processIDThe process ID
taskIDThe ID for your process task

Curl example

curl -X GET \ https://api.anaplan.com/2/0/workspaces/0a800b00e0000000f000001eab0d0000/models/F1111111C11111111B11111F1111E11F/processes/118000000001/tasks/B7EA9FEC0FF2488B9A9E6040B6B26753 \ -H 'authorization: AnaplanAuthToken {token}' \ -H "Content-Type:application/json"

Response

{

   "meta":{

      "schema":"https://api.anaplan.com/2/0/models/F1111111C11111111B11111F1111E11F/objects/task"

   },

   "status":{

      "code":200,

      "message":"Success"

   },

   "task":{

      "taskId":"B7EA9FEC0FF2488B9A9E6040B6B26753",

      "currentStep":"Failed.",

      "progress":0.0,

      "result":{

         "details":[

            {

               "localMessageText":"The uploaded file is no longer available; please upload the file again",

               "occurrences":0,

               "type":"internalError"

            }

         ],

         "failureDumpAvailable":false,

         "nestedResults":[

            {

               "details":[

                  {

                     "localMessageText":"The uploaded file is no longer available; please upload the file again",

                     "occurrences":0,

                     "type":"importFailedGeneralError",

                     "values":[

                        "errorMessage",

                        "The uploaded file is no longer available; please upload the file again"

                     ]

                  }

               ],

               "failureDumpAvailable":false,

               "objectId":"112000000000",

               "successful":false

            },

            {

               "details":[

                  {

                     "occurrences":0,

                     "type":"exportSucceeded",

                     "values":[

                        "fileSize",

                        "0",

                        "serverAlert",

                        null,

                        "exportName",

                        null

                     ]

                  }

               ],

               "failureDumpAvailable":false,

               "objectId":"116000000004",

               "successful":false

            }

         ],

         "objectId":"118000000001",

         "successful":false

      },

      "taskState":"COMPLETE",

      "creationTime":1570823656906

   }

}