Use this call to retrieve the IDs, codes, and names for items in a specified dimension. The dimension must be a list, a list subset, a line item subset, or the Users dimension.

This endpoint helps an integration understand the full set of valid members for a dimension before importing, exporting, mapping, validating, or transforming data.

Calls at model-level don't support the Time dimension. The calls return a 400 response. To avoid this, use the view dimension instead.

Notes:

  • To use this call, you must be a Workspace Administrator.
  • This call is on the model-level. It returns all dimension items as it doesn't have view-level hiding, filtering, or Selective Access. For the view-level endpoint, see Retrieve selected items in a dimension.
  • If codes haven't been set for an item, then the response excludes the code field.
  • This call only supports the retrieval of dimensions and items from a dimension that contains a maximum of 1,000,000 items.
    The call returns a 400 response for any more than that number of items.

Method and endpoint

GET

/models/{modelGuid}/dimensions/{dimensionId}/items

Parameters

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

Curl example

curl -X GET
'https://api.anaplan.com/2/0/models/{modelGuid}/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" : [
    {
      "code" : "N",
      "id" : "200000000001",
      "name" : "North"
    },
    {
      "code" : "E",
      "id" : "200000000002",
      "name" : "East"
    },
    {
      "code" : "S",
      "id" : "200000000003",
      "name" : "South"
    },
    {
      "code" : "W",
      "id" : "200000000004",
      "name" : "West"
    },
    {
      "id" : "200000000000",
      "name" : "Total Company"
    }
  ]
}