Sign in
Objects

Get object custom attributes

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).

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

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

Changed in 4 of the 115 revisions of this API.32

  • ef2ed4fdc37611See the full diff
    • ▲

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

      response-property-list-of-types-widened

    • ○

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

      response-optional-property-added

  • 051240cd3a791See the full diff
    • ▲

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

      response-body-type-changed

  • 7d6c145c0be01See the full diff
    • ○

      endpoint added

      endpoint-added

  • c6aaf3632e481See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 40 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog