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

Poll the status of your export task and repeat until the task is complete. 

The possible states of a task are:

StateDescription
NOT_STARTEDScheduled but not started.
IN_PROGRESSCurrently running.
COMPLETEDone, either successfully or not.
CANCELLINGCancellation has begun but not yet complete.
CANCELLEDCancellation complete and any changes are rolled back.

Method and endpoint

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

GET

Parameters

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

Curl example

curl -X GET \ https://api.anaplan.com/2/0/workspaces/0a800b00e0000000f000001eab0d0000/models/F1111111C11111111B11111F1111E11F/exports/116000000005/tasks/8FEEA107FF67414E855084A7698D3C7C \ -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":{

      "type":"taskInformation",

      "taskId":"BFEC582EBD4146068FE4061831C8F0F0",

      "currentStep":"Complete.",

      "progress":1,

      "result":{

         "failureDumpAvailable":false,

         "objectId":"116000000002",

         "successful":true

      },

      "taskState":"COMPLETE"

   }

}