Use this call to retrieve identifiers of line items for a specific module.

This helps identify the measures or fields available in a module before reading, mapping, or documenting data.

Notes:

  • To use this call, you must be a Workspace Administrator.
  • The Model Role of the user must allow Read access to the module. Otherwise, this call returns a 404 Not Found HTTP status.
  • The items in the response are in the same order that appear in the Anaplan UI.
  • This call returns line items for a specific module. For all the line items in the model see Retrieve All Line Items in a Model.
  • If this query contains an invalid or a non-existing Module ID, the API returns a 404 Not Found HTTP status.

Method and endpoint

GET

/models/{modelId}/modules/{moduleId}/lineItems

Parameters

ParameterDetails
{modelId}
  • Required
  • Type: String
  • Description: the ID for the model
  • Example: 75A40874E6B64FA3AE0743278996850F
{moduleId}
  • Required
  • Type: Number
  • Description: the ID for the module
  • Example: 102000000000

Curl example

curl -X GET 'https://api.anaplan.com/2/0/models/{modelId}/modules/{moduleId}/lineItems' \
-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/lineItem"
   },
   "status": {
       "code": 200,
       "message": "Success"
   },
   "items": [
       {
           "moduleId": "102000000000",
           "moduleName": "Sales Entry",
           "id": "206000000000",
           "name": "Quantity Sold"
       },
       {
           "moduleId": "102000000000",
           "moduleName": "Sales Entry",
           "id": "206000000001",
           "name": "Price"
       },
       {
           "moduleId": "102000000000",
           "moduleName": "Sales Entry",
           "id": "206000000002",
           "name": "Revenue"
       }
   ]
}