REST Resource: enterprises.devices

Resource: Device

Device resource represents an instance of enterprise managed device in the property.

JSON representation
{
  "name": string,
  "type": string,
  "assignee": string,
  "traits": {
    object
  },
  "parentRelations": [
    {
      object (ParentRelation)
    }
  ]
}
Fields
name

string

Required. The resource name of the device. For example: "enterprises/XYZ/devices/123".

type

string

Output only. Type of the device for general display purposes. For example: "THERMOSTAT". The device type should not be used to deduce or infer functionality of the actual device it is assigned to. Instead, use the returned traits for the device.

assignee
(deprecated)

string

Output only. The name of the structure/room where the device is assigned to. For example: "enterprises/XYZ/structures/ABC" or "enterprises/XYZ/structures/ABC/rooms/123"

traits

object (Struct format)

Output only. Device traits.

parentRelations[]

object (ParentRelation)

Assignee details of the device.

ParentRelation

Represents device relationships, for instance, structure/room to which the device is assigned to. For now this is only filled in the enterprise flow.

JSON representation
{
  "parent": string,
  "displayName": string
}
Fields
parent

string

Output only. The name of the relation -- e.g., structure/room where the device is assigned to. For example: "enterprises/XYZ/structures/ABC" or "enterprises/XYZ/structures/ABC/rooms/123"

displayName

string

Output only. The custom name of the relation -- e.g., structure/room where the device is assigned to.

Methods

executeCommand

Executes a command to device managed by the enterprise.

get

Gets a device managed by the enterprise.

list

Lists devices managed by the enterprise.