NEnetxms
Objects

Get objects with filters

Changed on

Returns all objects available to the current user, optionally filtered. Supports filtering by name, class, parent, zone, geographical area, state, and custom attributes.

get/objects

Request

  • Base URL
    http://127.0.0.1:8000
  • URL
    http://127.0.0.1:8000/objects
  • Auth
    • HTTP basic
    • or API key in cookie session_handle
    • or API key in header Session-Id

Query parameters

areastring

Geographical area filter as "lat1,lon1,lat2,lon2" (bounding box)

classstring

Comma-separated list of object class names (e.g., "Node,Container")

namestring

Name filter (glob pattern or regex if regex=true)

parentinteger

Filter objects that are children of given parent object ID

primaryNamestring

Filter nodes by primary name (glob pattern or regex if regex=true)

statestring

Filter nodes by state flags (integer or hex with 0x prefix)

topLevelOnlyboolean

Return only top-level objects

regexboolean

Treat name and custom attribute filters as regex patterns

zonestring

Comma-separated list of zone UINs

@{attributeName}string

Custom attribute filter. Use @attributeName=value format

Response

List of objects

Changes

  • 32f48ec94aecRevision changes
    • breaking

      for the query request parameter topLevelOnly, default value false was added

    • breaking

      for the query request parameter parent, the type changed from string to integer, and format from no format to int64

    • warning

      deleted the query request parameter @custom_attribute_name

    • warning

      deleted the query request parameter useRegex

    • info

      added the new optional query request parameter @{attributeName}

    • info

      added the new optional query request parameter primaryName

    • info

      added the new optional query request parameter regex

    • info

      added the new optional query request parameter state

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 910d3ad08e09Revision changes
    • info

      api operation id getObjects was added

    • info

      added the non-success response with the status