Check the operation's dump file to identify failures during a process action.

To prevent timeouts on large files, download the dump file in chunks.
It is possible to download dump files without chunking, but it is strongly recommended that chunking is used instead.
1. Query the number of chunks in a dump file.
2. Download the chunks sequentially.
3. Concatenate the chunks on your host.

Note: The taskID is the last task of the user who carried out the specified task.

Query the number of chunks in a dump file

Begin by querying the number of chunks using the /chunks endpoint. It is possible for a dump file to be very large. To help manage the size of a dump file and prevent timeouts, download the dump file in chunks. Chunks are 10mb or less and numbered sequentially from 0. In order to get the dump file for a particular action in the process, use the ObjectID. The ObjectID can be obtained from the /tasks/{taskId} endpoint.

Method and endpoint

GET

/workspaces/{workspaceId}/models/{modelId}/processes/{processId}/tasks/{taskId}/dumps/{objectId}/chunks

Parameters

ParameterDescription
workspaceId
  • Required
  • Type: string
  • Description: The workspace ID
  • Example: 8a8b8c8d8e8f8g8i
modelId
  • Required
  • Type: string
  • Description: The model ID
  • Example: 75A40874E6B64FA3AE0743278996850F
processId
  • Required
  • Type: number
  • Description: The process ID
  • Example: 118000000002
taskId
  • Required
  • Type: string
  • Description: The task ID
  • Example: 5B882A63354A4B45A21C16F3644C9C1B
objectId
  • Required
  • Type: number
  • Description: The ID of the specified dump object
  • Example: 117000000015

Curl example

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

Response

Response 200 (application/json)

{
   "meta":{
      "paging":{
         "currentPageSize":1,
         "offset":0,
         "totalSize":3
      },
      "schema":"https://api.anaplan.com/2/0/models/75A40874E6B64FA3AE0743278996850F/objects/chunk"
   },
   "status":{
      "code":200,
      "message":"Success"
   },
   "chunks":[
      {
         "id":"0",
         "name":"Chunk 0"
      },
      {
         "id":"1",
         "name":"Chunk 1"
      },
      {
         "id":"2",
         "name":"Chunk 2"
      },
      {
         "id":"3",
         "name":"Chunk 3"
      }
   ]
}