v1

latestOpenAPI 3.0.0Apache License Version 2.02026-07-24163274903.6 KB

Hierarchy Service

getHierarchyDetailsV1

Retrieve the details of a specific hierarchy.

get/cruise/hierarchy/v1/getHierarchyDetails/{hierarchyType}

Path parameters

hierarchyTypestring required

Hierarchy type to retrieve.

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

"Hierarchy Type" (the name of the hierarchy) from Hierarchy setup screen.

locationCodestring

"Location Code" from Hierarchy setup screen.

Example response

{
  "hierarchyType": "Corporate Structure",
  "levels": [
    {
      "levelDescription": "Regions",
      "levelName": "Regions",
      "levelNumber": 2
    }
  ],
  "locationCode": "129000",
  "locations": [
    {
      "levelDescription": "Regions",
      "levelName": "Regions",
      "levelNumber": 2,
      "locationCode": "300004",
      "logicalName": "Northeast",
      "parentLogicalName": "Corporate"
    }
  ]
}