Use this call to retrieve metadata for a specified list.

This helps confirm that the integration is targeting the correct list and understand its structure before working with its items.

MetadataDescription
categoryThe category to which the list is assigned.
dataTagsThe data tags associated with the list.
displayNamePropertyIf present it indicates the name of the property set on the list.
hasSelectiveAccessIf the value is true, this list uses selective access.
idThe list ID.  This corresponds to the listId parameter.
itemCountThe number of list items present in the list.
managedByNot currently used.
nameThe list name.
nextitemIndexContains the index of the next new item in the list. Used only by numbered lists.
numberedListA true value indicates this is a numbered list.
parent

The parent hierarchy, which includes this information for the parent list:

  • id
  • name
permittedItemsIndicates how many more items you can add to the existing list. This value changes when the number of items in the list change.
productionDataA true value indicates this is a production list in Application Lifecycle Management (ALM).
properties

The list properties, which include:

  • dataTags
  • format
  • formula
  • notes
  • referencedBy
subsets

A list of subsets associated with the list hierarchy, which includes the following information for the parent list:

  • id
  • name
topLevelItemIf present, indicates the top level item in a hierarchy.
useTopLevelAsPageDefaultA true value indicates this list is the default item in a page selector.
workflowEnabledA true value indicates this list is enabled for Workflow.

If any of the metadata values are not set for a list (for example, no parent or no top-level item), then the result omits the metadata entry.

Note: To use this call, you must be a Workspace Administrator.

Method and endpoint

GET

/workspaces/{workspaceId}/models/{modelId}/lists/{listId}

Parameters

ParameterDetails
{workspaceId}
  • Required
  • Type: String
  • Description: The workspace ID
  • Example: 8a8196b15b7dbae6015b8694411d13fe
{modelId}
  • Required
  • Type: String
  • Description: the ID for the model
  • Example: 75A40874E6B64FA3AE074327899685
{listId}
  • Required
  • Type: string
  • Description: The list ID.
  • Example: 101000000001

Curl example

curl -X GET 'https://api.anaplan.com/2/0/workspaces/{workspaceId}/models/{modelId}/lists/{listId}' \
-H 'Accept: application/json' \
-H 'Authorization: AnaplanAuthToken {anaplan_auth_token}' \
-H 'Content-Type: application/json'

Response

Response header

Content-Type: application/json

Response 200 body

{
    "meta": {
        "schema": "https://api.anaplan.com/2/0/models/102B/objects/list"
    },
    "status": {
        "code": 200,
        "message": "Success"
    },
    "metadata": {
        "id": "101000000001",
        "name": "Sales Reps",
        "properties": [
            {
                "name": "Salesforce",
                "format": "TEXT",
                "notes": "",
                "referencedBy": ""
            },
            {
                "name": "Mail",
                "format": "TEXT",
                "notes": "",
                "referencedBy": ""
            }
        ],
        "hasSelectiveAccess": false,
        "parent": {
            "id": "101000000000",
            "name": "Organization"
        },
        "managedBy": "",
        "numberedList": false,
        "useTopLevelAsPageDefault": false,
        "itemCount": 1,
        "workflowEnabled": false,
        "productionData": false
    }
}