Skip to main content

Smart View Hierarchy APIs (1.0)

Download OpenAPI specification:Download

Empower yourself with Smart View Hierarchy APIs. Use these APIs to obtain location and power hierarchy for invoking other APIs. Given an account number, IBX code, and an asset Id, returns the corresponding location and power hierarchy of related assets. Required query parameters to obtain a valid response from these endpoints are account number and IBX code.

Smart View Hierarchy APIs

APIs to get Location, Power Hierarchy

Fetch the Location Hierarchy

The location hierarchy endpoint returns the location hierarchy. This endpoint provides data for invoking other APIs such as Environmental APIs that require location hierarchy information.

query Parameters
accountNo
required
string

Customer Account Number

ibx
string

IBX Code

header Parameters
Authorization
required
string

Specify the OAuth Bearer token with prefix 'Bearer '.

Authorization
required
string

Specify the Access token with prefix 'Bearer'.

Responses

Response Schema: application/json
Array
levelType
string
Enum: "ibx" "zone" "cage" "cabinet" "sensor"

levelType indicates which level in the location hierarchy does the node belong to.

levelValue
string

ibx code, zone us id, cage us id, cabinet us id, sensor number for levelType ibx, zone, cage, cabinet, sensor resp.

label
string

ibx code, zone unique space id, cage unique space id, cabinet unique space id, sensor number for levelType ibx, zone, cage, cabinet, sensor resp.

children
Array of objects (HierarchyNode)

Response samples

Content type
application/json
[
  • {
    }
]

Fetch the Power Hierarchy

The power hierarchy endpoint returns the power hierarchy. This endpoint provides data for invoking other APIs such as Power APIs that require power hierarchy information.

query Parameters
accountNo
required
string

Customer Account Number

ibx
string

IBX Code

header Parameters
Authorization
required
string

Specify the OAuth Bearer token with prefix 'Bearer '.

Authorization
required
string

Specify the Access token with prefix 'Bearer'.

Responses

Response Schema: application/json
Array
levelType
string
Enum: "ibx" "cage" "cabinet" "circuit"

levelType indicates which level in the power hierarchy does the node belong to.

levelValue
string

ibx code, cage us id, cabinet us id, circuit number for levelType ibx, cage, cabinet, circuit resp.

label
string

ibx code, cage unique space id, cabinet unique space id, circuit label for levelType ibx, cage, cabinet, circuit resp.

children
Array of objects (PowerHierarchyNode)

ibx, cage, cabinet nodes can have cage, cabinet and circuit, circuit nodes as children respectively.

Response samples

Content type
application/json
[
  • {
    }
]