Use this call to initiate a large volume read request of view data. This enables you to read data from views that are larger than a million cell count.
This starts an asynchronous data extraction process when the view contains too much data to retrieve efficiently in a single lightweight request.
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
/workspaces/{workspaceId}/models/{modelId}/views/{viewId}/readRequests/
Parameters
| Parameters | Details |
{workspaceId} |
|
{modelId} |
|
{viewId} |
|
Request body
This API supports exporting data in the following formats:
| Type | Description | More information |
GRID_ALL_PAGES | This layout respects the existing sorting and filtering you have imposed on a data grid before you launch the export. | Export grid |
TABULAR_SINGLE_COLUMN | This layout takes all dimensions and puts them in columns, with the final column reserved for data. | Export tabular single column |
TABULAR_MULTI_COLUMN | This layout enables you to export multiple data columns. | Export Tabular Multiple Column |
Curl example
curl --location --request POST 'https://api.anaplan.com/2/0/workspaces/{workspaceId}/models/{modelId}/views/{viewId}/readRequests/' \
--header 'Authorization: AnaplanAuthToken AnaplanToken' \
--header 'Accept: application/json'
--data-raw '{
"exportType" : "TABULAR_MULTI_COLUMN"
}'
Response
Response 200 body
{
"meta": {
"schema": "https://api.anaplan.com/2/0/objects/viewReadRequest"
},
"status": {
"code": 200,
"message": "Success"
},
"viewReadRequest": {
"requestId": "0A06B0739F0E47BB92E2326C603D86EC",
"requestState": "IN_PROGRESS",
"url": "https://api.anaplan.com/2/0/workspaces/{workspaceId}/models/{modelId}/views/{viewId}/readRequests/{requestId}"
}
}
If the request is just submitted and not started, the response resembles:
{
"meta": {
"schema": "https://api.anaplan.com/2/0/objects/viewReadRequest"
},
"status": {
"code": 200,
"message": "Success"
},
"viewReadRequest": {
"requestId": "0A06B0739F0E47BB92E2326C603D86EC",
"requestState": "NOT_STARTED",
"url": "https://api.anaplan.com/2/0/workspaces/{workspaceId}/models/{modelId}/view/{viewId}/readRequests/{requestId}"
}
}