v1

latestOpenAPI 3.0.0Apache License Version 2.02026-07-24163274903.6 KB
Hierarchy Service

getHierarchiesV2

Retrieve a list of hierarchies.

get/hierarchy/v2/getHierarchies

Query parameters

includeNullboolean

Specify 'true' to output null data elements.

Headers

authenticationtokenstring required

Secure token for API authentication.

passwordstring

Password for the Crunchtime Application User.

sitenamestring required

Crunchtime site identifier. (test or production)

useridstring

User ID for the Crunchtime Application User.

X-B3-TraceIdstring

Optional trace identifier for troubleshooting.

Response

Success

hierarchyTypestring required

"hierarchyType" from Hierarchy setup screen

Example response

{
  "hierarchyType": "HierarchyType1"
}