UnitAttribute

Get unit attribute by id

Get unit attribute by id<br>You must have at least one of these scopes: 'unitattributes.read, setup.read, setup.manage'.<br>For fine-grained clients, you must have this permission: 'core.unit_attributes.read'.

get/inventory/v1/unit-attributes/{id}

Request

  • Base URL
    https://api.apaleo.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.apaleo.com/inventory/v1/unit-attributes/{id}
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: unitattributes.read, setup.read, setup.manage, admin

Path parameters

idstring required

The id of the unit attribute

Response

Returns unit attribute with specified id

idstring required

The id of the unit attribute

namestring required

The name of the unit attribute

descriptionstring nullable

The description of the unit attribute

Example response

{
  "id": "KQOSXHLS",
  "name": "Floor 1",
  "description": "Floor number"
}

Changes

No recorded changes to this operation across all 4 revisions of this API.