Use this to check dump files for failures.

This helps identify rejected records and diagnose data-quality, mapping, or formatting problems.

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.

Dump files are:

  • Removed 48 hours after the last access of the file or the next time an import task successfully executes with no errors.
  • Maintained on a user-by-user basis and overwritten when the user performs the same import.

When an import task has errors, the API maintains a dump file for the task ID with the error.  Any earlier task IDs are erased, though failureDumpAvailable can be True for those task IDs.  If a dump file is removed or replaced, then attempting to download the dump file via the API results in a 404 (Not found) HTTP status.

If you use /tasks?sort=-creationDate in the URL, it is possible for tasks created by other users to appear first for which the dump file is unavailable to the accessing user.  It is also possible that a task that the accessing user ran, and for which a dump file is still available, to be further down on the same list.

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

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.

Method and endpoint

GET

/workspaces/{workspaceId}/models/{modelId}/imports/{importId}/tasks/{taskId}/dump/chunks

Parameters

ParameterDescription
workspaceId
  • Required
  • Type: string
  • Description: The workspace ID
  • Example: 8a8b8c8d8e8f8g8i
modelId
  • Required
  • Type: string
  • Description: The model ID
  • Example: 75A40874E6B64FA3AE0743278996850F
importId
  • Required
  • Type: number
  • Description: The import ID
  • Example: 112000000007
taskID
  • Required
  • Type: string
  • Description: The task ID
  • Example: 88E90CC3E2B545C99A262284317F92EB

Curl example

curl -X GET \
https://api.anaplan.com/2/0/workspaces/{workspaceId}/models/{modelId}/imports/{importId}/tasks/{taskId}/dump/chunks
-H 'Authorization: AnaplanAuthToken {anaplan_auth_token}' \
-H 'Content-Type:application/json'

Response

Response 200 (application/json)

            "_Status_","Column 1","Parent","Code","Start Date","Leave Date","Column 6","Column 7","Start Dates","Column 9","Column 10","Column 11","_Line_","_Error_1_"
            {
            "meta" : {
                "paging" : {
                "currentPageSize" : 1,
                "offset" : 0,
                "totalSize" : 3
                },
                "schema" : "https://api.anaplan.com/2/0/models/CB0A5A4D5C5943B5837FF42C5FAA95E1/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"
            } ]