NEnetxms
Objects

List objects

Changed on

Retrieve a list of objects (with optional filter).

get/v1/objects

Request

  • Base URL
    http://127.0.0.1:8000
  • URL
    http://127.0.0.1:8000/v1/objects
  • Auth
    HTTP bearer

Query parameters

filterstring

Optional filter string. If provided, only objects with name or alias containing given string will be returned.

parentinteger

Optional parent object ID. If provided, only child objects of given parent object will be returned, otherwise all top-level objects will be returned.

Response

Successful retrieval of objects.

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

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