Get a list describing all available user hierarchies
GET {{baseUrl}}/api/model/hierarchies
This API gets a list of user hierarchies. The response describes all user hierarchies you can view or modify. The project ID is required to return all user hierarchy definitions in metadata. The changeset ID is required to return all user hierarchy definitions within a specific changeset. To execute the request, provide either the project ID or changeset ID. If you provide both, only the changeset ID is used. Immediately after creating a changeset, this list displays all user hierarchies available in the schema. If the caller creates new user hierarchies or deletes existing ones, the list of user hierarchies obtained by this call is updated to reflect the change. A changeset ID can be obtained using the changeset creation API. An authorization token is required to execute the request and can be obtained using Authentication endpoints.
Body
PARAM
| Key | Datatype | Required | Description |
limit
|
number | The maximum number of objects that can be returned by this method. If this property is not provided, all available objects are returned. | |
offset
|
number | Use this parameter to page through large result lists. Setting it to `0` (or not providing the parameter) starts at the beginning of the object list. |
HEADERS
| Key | Datatype | Required | Description |
X-MSTR-AuthToken
|
string | (Required) Authorization Token | |
X-MSTR-ProjectID
|
string | Project ID | |
X-MSTR-MS-Changeset
|
string | Changeset ID |
RESPONSES
ENDPOINTS