REST Resource: enterprises.devices
Stay organized with collections
Save and categorize content based on your preferences.
Resource: Device
Device resource represents an instance of enterprise managed device in the property.
| JSON representation |
{
"name": string,
"type": 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.
|
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.
| 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 |
|
|
Executes a command to device managed by the enterprise. |
|
|
Gets a device managed by the enterprise. |
|
|
Lists devices managed by the enterprise. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-08-07 UTC.
[null,null,["Last updated 2024-08-07 UTC."],[[["\u003cp\u003eThe Device resource represents an instance of an enterprise-managed device, containing information like name, type, traits, and parent relationships.\u003c/p\u003e\n"],["\u003cp\u003eParentRelation describes the relationship of a device to a structure or room within the enterprise, including its parent and display name.\u003c/p\u003e\n"],["\u003cp\u003eThis API provides methods to execute commands on devices, retrieve device details, and list devices managed by the enterprise.\u003c/p\u003e\n"]]],[],null,["# REST Resource: enterprises.devices\n\n- [Resource: Device](#Device)\n - [JSON representation](#Device.SCHEMA_REPRESENTATION)\n- [ParentRelation](#ParentRelation)\n - [JSON representation](#ParentRelation.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: Device\n----------------\n\nDevice resource represents an instance of enterprise managed device in the property.\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"type\": string, \"traits\": { object }, \"parentRelations\": [ { object (/nest/device-access/reference/rest/v1/enterprises.devices#ParentRelation) } ] } ``` |\n\n| Fields ||\n|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. The resource name of the device. For example: \"enterprises/XYZ/devices/123\". |\n| `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. |\n| `traits` | `object (`[Struct](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Struct)` format)` Output only. Device traits. |\n| `parentRelations[]` | `object (`[ParentRelation](/nest/device-access/reference/rest/v1/enterprises.devices#ParentRelation)`)` Assignee details of the device. |\n\nParentRelation\n--------------\n\nRepresents device relationships, for instance, structure/room to which the device is assigned to.\n\n| JSON representation |\n|-----------------------------------------------------|\n| ``` { \"parent\": string, \"displayName\": string } ``` |\n\n| Fields ||\n|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `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\" |\n| `displayName` | `string` Output only. The custom name of the relation -- e.g., structure/room where the device is assigned to. |\n\n| Methods ------- ||\n|------------------------------------------------------------------------------------------------|---------------------------------------------------------|\n| ### [executeCommand](/nest/device-access/reference/rest/v1/enterprises.devices/executeCommand) | Executes a command to device managed by the enterprise. |\n| ### [get](/nest/device-access/reference/rest/v1/enterprises.devices/get) | Gets a device managed by the enterprise. |\n| ### [list](/nest/device-access/reference/rest/v1/enterprises.devices/list) | Lists devices managed by the enterprise. |"]]
