Get All Hierarchies

This API enables you to query for all hierarchies on which the user has a role with Read privilege.

Syntax

The syntax for calling this method is:

GET <Base_Url>/hierarchies

A sample API call is as follows:

GET https://123.123.123.123/vCenter-CB/api/hierarchies

User Privilege

To call this API, you should be authenticated but no privileges are required.

API Response

If the operation is successful, the API gets an XML response with the following details.

XPath

Type

Min Occurs

Max Occurs

Description

Hierarchies/Hierarchy

 

1

unbounded

Represents all the created hierarchies.

Hierarchies/Hierarchy/@id

xs:int

1

1

ID of the hierarchy.

Hierarchies/Hierarchy/Name

xs:string

1

1

Name of the hierarchy.

Hierarchies/Hierarchy/Description

xs:string

1

1

Description of the hierarchy.

A sample response in XML is provided here.