Use this call to retrieve IDs, codes, and names for dimension items that apply for the specified line item.

This helps determine the valid dimensional intersections for a line item before reading, interpreting, or writing related data.

Notes:

  • To use this call, you must be a Workspace Administrator.
  • This call works with any dimension type.
  • Your requesting model role must allow read access to the module the line item belongs to. Otherwise, this call returns a 404 Not Found HTTP status.
  • The items in the response are ordered as listed in the Anaplan model.
  • The response returns items within a flat list (no hierarchy).
  • This returns dimension items that apply to a line item. For the view-level call, see Retrieve selected items in a dimension and for the model-level call, see Retrieve all items in a dimension.
  • This call only supports the retrieval of dimension items where the dimension contains a maximum of 1,000,000 items. If the specified dimension 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.
  • Providing a non-existent Line Item ID or Dimension ID returns a 404 Not Found HTTP status.
  • If the request provides an invalid line item ID or dimension ID this call returns a 400 Bad Request HTTP status.

Method and endpoint

GET

/models/{modelId}/lineItems/{lineItemId}/dimensions/{dimensionId}/items

Parameters

ParameterDetails
{modelId}
  • Required
  • Type: String
  • Description: the ID for the model
  • Example: 75A40874E6B64FA3AE0743278996850F
{lineItemId}
  • Required
  • Type: Number
  • Description: the line item ID
  • Example: 208000000000
{dimensionId}
  • Required
  • Type: Number
  • Description: the dimension ID
  • Example: 101000000028

Curl example

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

Response

Response headers

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 large volume view data

View these endpoints for further details on view data APIs: