Retrieve a data model hierarchy

Available since Strategy ONE (September 2025)

This workflow sample demonstrates how to retrieve a data model hierarchy's definition using the REST API with and without a changeset.

info

Get the authorization token needed to execute the request with POST /api/auth/login.

Get the project ID from GET /api/projects.

tip

Changesets are used in this workflow. For information on how to create and use changesets, see Changesets.

Get the definition of the specified data model's hierarchy

You can retrieve a specific data model's hierarchy. In the response, you can view relationships between attributes in the hierarchy and isolated attributes that are not part of any relationship.

Endpoint: GET /api/model/dataModels/{dataModelId}/hierarchy

Sample Request Without Changeset

• Request Headers

'Content-Type: application/json'
'Accept: application/json'
'X-MSTR-AuthToken: 8cmbn319k4s8fpujoe7lnl3l4q'
'X-MSTR-ProjectID: B7CA92F04B9FAE8D941C3E9B7E0CD754'

• Curl

curl -L -X GET 'http://demo.microstrategy.com/MicroStrategyLibrary/api/model/dataModels/04DCF4F028354FC0AE4B8120CB1983A6/hierarchy' \
-H 'X-MSTR-AuthToken: 8cmbn319k4s8fpujoe7lnl3l4q' \
-H 'X-MSTR-ProjectID: B7CA92F04B9FAE8D941C3E9B7E0CD754'

Sample Request With Changeset

• Request Headers

'Content-Type: application/json'
'Accept: application/json'
'X-MSTR-AuthToken: 8cmbn319k4s8fpujoe7lnl3l4q'
'X-MSTR-MS-Changeset: 768A0AA9E94547218BA930DD4245186B'

• Curl

curl -L -X GET 'http://demo.microstrategy.com/MicroStrategyLibrary/api/model/dataModels/04DCF4F028354FC0AE4B8120CB1983A6/hierarchy' \
-H 'X-MSTR-AuthToken: 8cmbn319k4s8fpujoe7lnl3l4q' \
-H 'X-MSTR-MS-Changeset: 768A0AA9E94547218BA930DD4245186B'

Sample Response Body: You can view the data model hierarchy's definition in the body of the response.

{
  "relationships": [
    {
      "parent": {
        "objectId": "EE709099BFB74E3A879A1F5B5ABBB037",
        "subType": "attribute",
        "name": "Year"
      },
      "child": {
        "objectId": "10DF161DF9C74FAEBA32795E7EE40E36",
        "subType": "attribute",
        "name": "Year Date"
      },
      "relationshipTable": {
        "objectId": "EE3E012AE58943B9B4AF84C3BC08888F",
        "subType": "logical_table",
        "name": "lu_year"
      },
      "relationshipType": "one_to_many"
    },
    {
      "parent": {
        "objectId": "ACAB111A1C5E46539D672CA380729B90",
        "subType": "attribute",
        "name": "Previous Year"
      },
      "child": {
        "objectId": "EE709099BFB74E3A879A1F5B5ABBB037",
        "subType": "attribute",
        "name": "Year"
      },
      "relationshipTable": {
        "objectId": "EE3E012AE58943B9B4AF84C3BC08888F",
        "subType": "logical_table",
        "name": "lu_year"
      },
      "relationshipType": "one_to_many"
    },
    {
      "parent": {
        "objectId": "29D13B51E7DD49999F641399E4C62FA4",
        "subType": "attribute",
        "name": "Quarter"
      },
      "child": {
        "objectId": "BBBF9A92A6DA4EADB8F587AFD4BD109C",
        "subType": "attribute",
        "name": "Quarter Date"
      },
      "relationshipTable": {
        "objectId": "2249F3085D67417E904FBF789EBAFDC8",
        "subType": "logical_table",
        "name": "lu_quarter"
      },
      "relationshipType": "one_to_many"
    },
    {
      "parent": {
        "objectId": "B4EB40B7F8E045849EDAFF4D473C12D1",
        "subType": "attribute",
        "name": "Previous Quarter"
      },
      "child": {
        "objectId": "29D13B51E7DD49999F641399E4C62FA4",
        "subType": "attribute",
        "name": "Quarter"
      },
      "relationshipTable": {
        "objectId": "2249F3085D67417E904FBF789EBAFDC8",
        "subType": "logical_table",
        "name": "lu_quarter"
      },
      "relationshipType": "one_to_many"
    },
    {
      "parent": {
        "objectId": "EE709099BFB74E3A879A1F5B5ABBB037",
        "subType": "attribute",
        "name": "Year"
      },
      "child": {
        "objectId": "F0A2CB8C9DA44CFAAC3F2BD4A0D0DBDD",
        "subType": "attribute",
        "name": "Last Year Quarter"
      },
      "relationshipTable": {
        "objectId": "2249F3085D67417E904FBF789EBAFDC8",
        "subType": "logical_table",
        "name": "lu_quarter"
      },
      "relationshipType": "one_to_many"
    }
  ],
  "isolatedAttributes": [
    {
      "objectId": "0195EF23D855468BAA2FB27C03F6CCAA",
      "subType": "attribute",
      "name": "Quarter Description"
    }
  ]
}

Response Code: 200 (Hierarchy's definition is returned successfully.)