NEnetxms
Objects

Get object custom attributes

Changed on

Retrieve the object's custom attributes as an array. Each element carries the attribute name, value, flags and the source object. This is the same representation that is embedded as the customAttributes array in the full object document. Inherited attributes are included; the sourceObject field identifies the object an inherited attribute originates from (0 when the attribute is defined directly on this object). Server-side attributes (names starting with $) are never returned.

get/v1/objects/{object-id}/custom-attributes

Request

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

Path parameters

object-idinteger required

Response

Array of custom attributes.

namestring

Attribute name.

sourceObjectinteger

ID of the object an inherited attribute originates from; 0 if defined directly on this object.

Example response

[
  {
    "name": "rack",
    "value": "A12",
    "flags": {
      "inheritable": false,
      "redefined": false,
      "conflict": false
    },
    "sourceObject": 0
  }
]

Changes

  • ef2ed4fdc376Revision changes
    • breaking

      response property items/value list-of-types was widened by adding types array and object to media type application/json of response 200

    • info

      added the optional property // to the response with the status

  • 051240cd3a79Revision changes
    • breaking

      the response's body type changed from object to array for status