Use this call to download the available pages, either when the read request is in progress, or when the request is completed. This request returns a CSV format response of the export list items.

This enables large datasets to be retrieved in manageable chunks, supporting retry logic and more reliable processing.

You can download pages while the export is in progress. You can download up to availablePages number of pages returned by the export status API. Note that page numbers start with zero. That means if 10 pages are available, you can download from page=0 through page=9.

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

Request supporting this feature

curl --{location} \
-X GET 'https://api.anaplan.com/2/0/workspaces/{workspaceId}/models/{modelId}/lists/{listId}/readRequests/{requestId}/pages/{pageNo}' \
-H 'Authorization: AnaplanAuthToken{anaplan_auth_token}' \
-H 'Accept: text/csv'

Method and endpoint

GET

/workspaces/{workspaceId}/models/{modelId}/lists/{listId}/readRequests/{requestId}/pages/{pageNo}

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
{requestId}
  • Required
  • Type: String
  • Description: The request ID
  • Example: 0A06B0739F0E47BB92E2326C603D86EC
{pageNo}
  • Required
  • Type: Number
  • Description: The page number (starting from 0)
  • Example: 0

Curl example

curl --{location} \
-X GET 'https://api.anaplan.com/2/0/workspaces/{workspaceId}/models/{modelId}/lists/{listId}/readRequests/{requestId}/pages/{pageNo}' \
-H 'Authorization: AnaplanAuthToken{anaplan_auth_token}' \
-H 'Accept: text/csv'

Response

Response 200 body

,Parent,Write,Read,Code,favourite,count
cake,,"gord.like@anaplan.com, adam.minister@anaplan.com",,c1,true,1
bread,,,adam.minister@anaplan.com,b2,false,4
pastry,,gord.like@anaplan.com,,p3,true,5