NEnetxms
Objects

Get object sub-tree

Changed on

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

Request

  • Base URL
    http://127.0.0.1:8000
  • URL
    http://127.0.0.1:8000/v1/objects/{object-id}/sub-tree
  • Auth
    HTTP bearer

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

class'AccessPoint' | 'AgentPolicyLogParser' | 'Asset' | 'AssetGroup' | 'AssetRoot' | 'BusinessService' | 'BusinessServiceProto' | 'BusinessServiceRoot' | 'Chassis' | 'Cluster' | 'Condition' | 'Container' | 'CoolingZone' | 'Dashboard' | 'DashboardGroup' | 'DashboardRoot' | 'Facility' | 'Generic' | 'Interface' | 'MobileDevice' | 'Network' | 'NetworkMap' | 'NetworkMapGroup' | 'NetworkMapRoot' | 'NetworkService' | 'Node' | 'NodeLink' | 'PowerDomain' | 'Rack' | 'Report' | 'ReportGroup' | 'ReportRoot' | 'Room' | 'Sensor' | 'ServiceCheck' | 'ServiceRoot' | 'Subnet' | 'Template' | 'TemplateGroup' | 'TemplateRoot' | 'VPNConnector' | 'Zone'
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
childrenObjectTreeNode[] circular

Changes

  • 2827204d68d9Revision changes
    • warning

      added the new Room enum value to the ///// response property for the response status

  • c4fbee63f843Revision changes
    • warning

      added the new CoolingZone enum value to the ///// response property for the response status

    • warning

      added the new Facility enum value to the ///// response property for the response status

    • warning

      added the new PowerDomain enum value to the ///// response property for the response status