Use this recipe when you need to read data from a saved view.
Process
- Authenticate.
Request:POSThttps://auth.anaplan.com/token/authenticateSave the returned authentication token.
- Find the workspace
Request:GET /workspacesSave the
idof the workspace asworkspaceId. - Find the model
Request:GET /workspaces/{workspaceId}/modelsSave the
idof the model asmodelId. - Find modules
Request:GET /workspaces/{workspaceId}/models/{modelId}/modulesSave the target module
idasmoduleId. - Find views for the module
Request:GET /workspaces/{workspaceId}/models/{modelId}/modules/{moduleId}/viewsSave the target view
idasviewId. - Retrieve view metadata
Request:GET /models/{modelId}/views/{viewId}Use the metadata to understand:
- Rows.
- Columns.
- Pages.
- Line items.
- Dimensions.
- Available page selectors.
- Retrieve view data
Request:GET /models/{modelId}/views/{viewId}/dataRetrieve the view data in the required format.
- Repeat for required page selections
Request:GET /models/{modelId}/views/{viewId}/dataIf the view uses page dimensions, repeat the request with the required page selections.
Result
The integration retrieves view metadata and the corresponding view data.
Failure handling
If data is missing or unexpected, check:
- Whether the saved view layout changed.
- Whether filters hide expected rows or columns.
- Whether page selectors are set correctly.
- Whether the integration user has access to all relevant data.
- Whether Dynamic Cell Access, selective access, or model role restrictions affect the output.