Retrieve the items from a dimension that match one of a list of names or a list or codes.

Notes:

  • To use this call, you must be a Workspace Administrator.
  • This call doesn't return results for names or codes for which an item doesn't exist.
  • If the given workspace, model, or dimension don't exist, this call returns a 404 code.
  • If the dimension doesn't support codes and codes are provided, this call returns a 400 code.
  • Supported dimensions are:
    • Lists - the request must include Name or Code of list item must be provided as input.
    • Time - the request must include the time period name (as visible in Anaplan UI, for example "May 21") as input.
    • Version - the request must include the name of the version as input.
    • Users - the request must include the user name as input.

Requests that support this feature

curl -X POST https://api.anaplan.com/2/0/workspaces/{workspaceId}/models/{modelId}/dimensions/{dimensionId}/items \
-H ‘Authorization: AnaplanAuthToken {anaplan_auth_token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' --data-raw '<see Request body>'

Method and endpoint

POST

/workspaces/{workspaceId}/models/{modelId}/dimensions/{dimensionId}/items

Parameters

ParameterDetails
{workspaceId}
  • Required in the supported request
  • Type: String
  • Description: The workspace ID
  • Example: 8a8196b15b7dbae6015b8694411d13fe
{modelId}
  • Required
  • Type: String
  • Description: the model ID
  • Example: 75A40874E6B64FA3AE074327899685
{dimensionId}
  • Required
  • Type: Number
  • Description: the dimension ID. This value must be the ID for any of these dimension types:
    • Lists
    • Time periods
    • Users
    • Versions
  • Example: 101000000001

Curl example

curl -X POST https://api.anaplan.com/2/0/workspaces/{workspaceId}/models/{modelId}/dimensions/{dimensionId}/items \
-H ‘Authorization: AnaplanAuthToken {anaplan_auth_token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' --data-raw '<see Request body>'

Response

Response 200 body

{
 "meta" : {
     "schema":"https://api.anaplan.com/2/0/objects/dimension"
 },
 "status" : {
   "code":200,
   "message":"Success"
 },
 "items":[
   {
     "name":"South",
     "id":"208000000001",
     "code":"S"
   },
   {
     "name":"West",
     "id":"208000000004",
     "code":"W"
   }
 ]
}