Export actions involves taking data out of Anaplan.
A Workspace Administrator or a user with a role configured to do so, can perform Export actions. For non-WSA user roles, the user account must meet these conditions:
- User must be able to authenticate against the authentication endpoint. For example, basic authentication, CA certificate, or OAuth.
- User must be authorized to access the model. The user needs to be an Exception User in the model if authenticating via basic authentication or CA certificate, but not for OAuth.
- User must be authorized to run the export action. This requires the user to:
- have a role that has access to the action (Roles > Actions)
- have read or write access to the module related to the action (Roles > Modules).
- If needed, check if the user has permissions to access the data from the action, due to Selective Access or Dynamic cell access. If they don't, there may be data missing from the export. However, the export will still run.
The export sequence with the API is:
- Get the list of export actions for your workspace and model.
GET https://api.anaplan.com/2/0/workspaces/{workspaceID}/models/{modelID}/exports - Get the definition for a specific export action.
GET https://api.anaplan.com/2/0/workspaces/{workspaceID}/models/{modelID}/exports/{exportID} - Run the export action.
POST https://api.anaplan.com/2/0/workspaces/{workspaceID}/models/{modelID}/exports/{exportID}/tasks - Get the status of the export task. Repeat until the task completes.
GET https://api.anaplan.com/2/0/workspaces/{workspaceID}/models/{modelID}/exports/{exportID}/tasks/{taskID} - Get the list of files in the model.
GET https://api.anaplan.com/2/0/workspaces/{workspaceID}/models/{modelID}/files - Retrieve the list of export file chunks.
GET https://api.anaplan.com/2/0/workspaces/{workspaceID}/models/{modelID}/files/{fileID}/chunks/ - Retrieve the export file chunks.
GET https://api.anaplan.com/2/0/workspaces/{workspaceID}/models/{modelID}/files/{fileID}/chunks/{chunkID}
