NEnetxms
Objects

Get object by ID

Changed on

Returns detailed information about a specific object

get/objects/{object-id}

Request

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

Path parameters

object-idstring required

Object ID or GUID

Response

Object information

objectIdinteger
guidstring uuid
objectNamestring
aliasstring
nameOnMapstring
objectClassinteger
categoryIdinteger
flagsinteger
status'NORMAL' | 'WARNING' | 'MINOR' | 'MAJOR' | 'CRITICAL' | 'UNKNOWN' | 'UNMANAGED' | 'DISABLED' | 'TESTING'
isDeletedboolean
inMaintenanceModeboolean
maintenanceInitiatorIdinteger
commentsstring
commentsSourcestring
mapImagestring uuid
drillDownObjectIdinteger
trustedObjectsinteger[]
inheritAccessRightsboolean
creationTimeinteger
parentsinteger[]
childreninteger[]
dashboardsinteger[]
customAttributesobject
urlsobject[]
responsibleUsersinteger[]
objectClassNamestring

Changes

  • 32f48ec94aecRevision changes
    • info

      added the non-success 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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 getObject was added

    • info

      added the non-success response with the status