Use this call to retrieve selected IDs, codes, and names for items in a specified dimension.

This endpoint helps an integration work with a targeted subset of dimension members instead of retrieving the full dimension, which is useful for validation, filtering, or mapping workflows.

It returns data as filtered by the page builder when they configure the view. This call respects hidden items, filtering selections, and Selective Access. If the view contains hidden or filtered items, these don't display in the response.

Notes:

  • To use this call, you must be a Workspace Administrator.
  • This call works with any dimension type.
  • The items in the response may not be ordered.
  • The response returns items within a flat list (no hierarchy).
  • This is a view-level call. For the model-level call, see Retrieve all data for items in a dimension.
  • This call only supports the retrieval of dimension items within a view that contains a maximum of 1,000,000 cells. If the specified view contains more than 1,000,000 dimension items, then the call returns a 400 Bad Request HTTP status, instead of a subset of the dimension items. Use the quick sum bar in Anaplan to identify the number of dimension items in a view.
  • The viewId in this request can also be replaced by any valid lineItemId. If the Line Item has a changed dimensionality (has a Subsidiary View), the response returns the applicable dimension items for the given dimension. Otherwise, the response returns all default applicable dimension items for the given dimension.

Method and endpoint

GET

/models/{modelId}/views/{viewId}/dimensions/{dimensionId}/items

Parameters

ParameterDetails
{modelId}
  • Required
  • Type: String
  • Description: the ID for the model
  • Example: 75A40874E6B64FA3AE074327899685
{viewId}
  • Required
  • Type: Number
  • Description: the ID for the view
  • Example: 102000000000
{dimensionId}
  • Required
  • Type: Number
  • Description: the ID for the dimension
  • Example: 101000000028

Curl example

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

Response

Response header

Content-Type: application/json

Response 200 body

{
  "meta": {
    "schema": "https://api.anaplan.com/2/0/objects/dimension"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "items": [{
      "id": "220000000001",
      "name": "England"
    },
    {
      "id": "220000000002",
      "name": "Wales"
   }]
}

Group read module, view metadata, and limited volume cell data

View these endpoints for further details on module and view data APIs: