Use this call to check on the status of an export action after a bulk data long request is initiated. This enables you to start the download of the pages from the directory where you download the export file.

This lets the integration monitor progress and determine when the requested list data is ready to download.

Note: To use this call, you must be a Workspace Administrator.

Method and endpoint

GET

/workspaces/{workspaceId}/models/{modelId}/lists/{listId}/readRequests/{requestID}

Parameters

ParametersDetails
{workspaceId}
  • Required
  • Type: String
  • Description: The workspace ID
  • Example: 8a8196b15b7dbae6015b8694411d13fe
{modelId}
  • Required
  • Type: String
  • Description: The model ID
  • Example: 75A40874E6B64FA3AE0743278996850F
{listId}
  • Required
  • Type: Number
  • Description: The list ID.
  • Example: 101000000001
{requestId}
  • Required
  • Type: String
  • Description: The request ID
  • Example: 0A06B0739F0E47BB92E2326C603D86EC

Curl example

curl -X GET / 'https://api.anaplan.com/2/0/workspaces/{workspaceId}/models/{modelId}/lists/{listId}/readRequests/{requestID}' /
-H 'Authorization: AnaplanAuthToken {anaplan_auth_token}' /
-H 'Accept: application/json'

Response

Response scenarios

  • When requestState is COMPLETE and successful is true , the export has completed successfully and the user can download all the pages.
  • When requestState is COMPLETE and successful is false, this means the export failed. Retry and start a new export.
  • When requestState is IN_PROGRESS the export hasn't yet completed, but you can download the available pages shown by the availablePages field.
  • When requestState is NOT_STARTED then check the status again.
  • When requestState is CANCELLED then this request is completed by a 'DELETE' call.

Response 200 body

{
       "meta": {
           "schema": "https://api.anaplan.com/2/0/objects/listReadRequest"
       },
       "status": {
           "code": 200,
           "message": "Success"
       },
       "listReadRequest": {
           "requestId": "0A06B0739F0E47BB92E2326C603D86EC",
           "listId": 101000000014,
           "requestState": "COMPLETE",
           "url": "https://api.anaplan.com/2/0/workspaces/{workspaceId}/models/{modelId}/lists/{listId}/readRequests/{requestId}",
           "availablePages": 100
           "successful": true
       }
   }

Following is the response when the large read request is in progress:

  {
       "meta": {
           "schema": "https://api.anaplan.com/2/0/objects/listReadRequest"
       },
       "status": {
           "code": 200,
           "message": "Success"
       },
       "listReadRequest": {
           "requestId": "0A06B0739F0E47BB92E2326C603D86EC",
           "listId": 101000000014,
           "requestState": "IN_PROGRESS",
           "url": "https://api.anaplan.com/2/0/workspaces/{workspaceId}/models/{modelId}/lists/{listId}/readRequests/{requestId}",
           "availablePages": 50,
           "successful": true
       }
   }