Use this call to initiate a large volume read request on a list. This enables you to read data from lists that are larger than a million lines.

This enables the integration to request a large list extract without relying on a single immediate response, which helps avoid timeouts or oversized payloads.

Notes:

  • To use this call, you must be a Workspace Administrator.
  • Use the Delete read requests call to clear all pages from completed exports as soon as you download all pages. Doing so will make space available for future exports.

Method and endpoint

POST

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

Parameters

ParametersDetails
{workspaceId}
  • Required in the first supported request (see Requests supporting this feature)
  • 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

Curl example

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

Response

Response 200 body

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

If the request is just submitted and not started, the response resembles:

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