1. Data integration
  2. Anaplan API
  3. Integration API v2.0
  4. Use the bulk APIs
  5. Perform an export action
  6. Retrieve the list of export file chunks

Anaplan provides export files in chunks. Run this call to get the total number of file chunks in the export file.  This tells you how many file chunks you will retrieve in the next call.

Method and endpoint

https://api.anaplan.com/2/0/workspaces/{workspaceID}/models/{modelID}/files/{fileID}/chunks/

GET

Parameters

ParameterDescription
AnaplanAuthToken:{token}Your Anaplan authentication token value.
workspaceIDThe workspace ID
modelIDThe model ID
fileIDThe file ID

Curl example

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

Response

{

   "meta":{

      "paging":{

         "currentPageSize":4,

         "offset":0,

         "totalSize":4

      },

      "schema":"https://api.anaplan.com//2/0/models/F1111111C11111111B11111F1111E11F/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"

      }

   ]

}

Disclaimer

We may update our documentation occasionally, but will only do so in a way that does not negatively affect the features and functionality of the Anaplan service.