Use this call to retrieve all view IDs and names for a specified module.

Helps narrow view discovery to a known module, making it easier to target the correct view for metadata inspection or data retrieval. This call also returns the default view for the module. If the user adds the query parameter includesubsidiaryviews=true, unsaved subsidiary views will also be included in the results.

Notes:

  • To use this call, you must be a Workspace Administrator
  • For the default view, the {viewId} is the same as the {moduleId}
  • For unsaved subsidiary views, the {viewId} and {viewName} are the same as the {lineItemId} and {lineItemName} that the subsidiary view is created from

Method and endpoint

GET

/models/{modelId}/modules/{moduleId}/views

Parameters

ParameterDetails
{modelId}
  • Required
  • Type: String
  • Description: the ID for the model
  • Example: 75A40874E6B64FA3AE074327899685
{moduleId}
  • Required
  • Type: number
  • Description: the ID for the module
  • Example: 102000000028
{includesubsidiaryviews}
  • Optional (default false)
  • Type: String
  • Description: Whether the response should include unsaved subsidiary views. The field is interpreted as false if anything other than true is specified
  • Example: ?includesubsidiaryviews=true

Curl example

curl -X GET 'https://api.anaplan.com/2/0/models/{modelId}/modules/{moduleId}/views' \
-H 'Authorization: AnaplanAuthToken {anaplan_auth_token}' \
-H 'Accept: application/json'

Response

Response header

Content-Type: application/json

Response 200 body

{
  "meta": {
    "paging": {
      "currentPageSize": 1,
      "offset": 0,
      "totalSize": 1
    },
    "schema": "https://api.anaplan.com/2/0/objects/view"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "views": [
    {
      "code": "",
      "id": "102000000000",
      "name": "default",
      "moduleId": "102000000000"
    },
    {
      "code": "",
      "id": "203000000000",
      "name": "SavedView",
      "moduleId": "102000000000"
    }
  ]
}