CRcrunchtime
Hierarchy Service

getHierarchiesV1

Retrieve a list of hierarchies.

get/cruise/hierarchy/v1/getHierarchies

Request

  • Base URL
    //webservices-test.net-chef.com (relative, and the document’s source URL is not known)
  • URL
    //webservices-test.net-chef.com/cruise/hierarchy/v1/getHierarchies
  • Auth
    none declared. Required headers: authenticationtoken, sitename

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

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

Example response

{
  "hierarchyType": "Corporate Structure"
}

Changes

No recorded changes to this operation across all 1 revision of this API.