Objects

Get object sub-tree

Retrieve a recursively nested sub-tree of objects starting from the specified parent object. Each node carries its accessible children under a children property.

get/v1/objects/{object-id}/sub-tree

Path parameters

object-idinteger required

Parent object ID

Query parameters

classstring

Optional comma-separated list of object class names. If provided, only objects of the listed classes (and ancestors that lead to them) are returned. Unknown class names are ignored.

maxDepthinteger

Maximum tree depth to traverse. Values above 100 are capped at 100.

Response

Object sub-tree retrieved successfully

aliasstring

Object alias

categoryinteger

Object category ID

guidstring uuid

Object GUID

idinteger

Object ID

isInMaintenanceModeboolean

true if object is in maintenance mode

isMaintenanceApplicableboolean

true if object can be placed into maintenance mode

isMaintenanceScheduledboolean

true if object has pending scheduled maintenance

namestring

Object name

timestampstring date-time

Object last change timestamp

status0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8

Changes

Changed in 10 of the 115 revisions of this API.51618

Sep 21, 20262827204d68d91See the full diff
- ●
  added the new Room enum value to the ///// response property for the response status
  response-property-enum-value-added
Sep 6, 2026c4fbee63f8433See the full diff
- ●
  added the new CoolingZone enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new Facility enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new PowerDomain enum value to the ///// response property for the response status
  response-property-enum-value-added
Aug 19, 202604731b73e7231See the full diff
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
Aug 17, 2026070b10a450e21See the full diff
- ▲
  the ////// response's property type changed from integer to string for status
  response-property-type-changed
Aug 12, 2026595d081990401See the full diff
- ▲
  the ////// response's property type changed from string to integer for status
  response-property-type-changed
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 12, 202647655614e52c1See the full diff
- ▲
  the ////// response's property type changed from integer to string for status
  response-property-type-changed
Aug 4, 2026fa1d1baee4021See the full diff
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
Jun 11, 2026021382e189552See the full diff
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
Jun 10, 202658744380028d1103See the full diff
- ▲
  the response's property type changed from object to no type for status
  response-property-type-changed
- ●
  deleted the query request parameter filter
  request-parameter-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ○
  added the new optional query request parameter class
  new-optional-request-parameter
- ○
  added the new optional query request parameter maxDepth
  new-optional-request-parameter
- ○
  added subschema #2 to the response property allOf list for the response status
  response-property-all-of-added
May 8, 2026c6aaf3632e481211See the full diff
- ▲
  the response's property type changed from no type to object for status
  response-property-type-changed
- ●
  deleted the query request parameter class
  request-parameter-removed
- ●
  deleted the query request parameter maxDepth
  request-parameter-removed
- ○
  added the new optional query request parameter filter
  new-optional-request-parameter
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  removed subschema #2 from the response property allOf list for the response status
  response-property-all-of-removed
This revision also has 40 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history