REST Resource: enterprises.structures.rooms
Stay organized with collections
Save and categorize content based on your preferences.
Resource: Room
Room resource represents an instance of sub-space within a structure such as rooms in a hotel suite or rental apartment.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-08-07 UTC."],[[["\u003cp\u003eThe Room resource represents sub-spaces within a structure, like rooms in a hotel or apartment.\u003c/p\u003e\n"],["\u003cp\u003eRooms have traits and are identified by a unique resource name.\u003c/p\u003e\n"],["\u003cp\u003eYou can get information about individual rooms or list all rooms managed by an enterprise using the provided methods.\u003c/p\u003e\n"]]],["The `Room` resource represents a sub-space within a structure. It has a `name` (resource identifier) and `traits` (room-specific attributes) represented as a JSON object. Key actions include retrieving a single room's details (`get`) and listing all rooms associated with an enterprise (`list`). The resource is identified with the format: \"enterprises/XYZ/structures/ABC/rooms/123\". The format of the data of a room is: `{\"name\": string, \"traits\": {object}}`.\n"],null,["# REST Resource: enterprises.structures.rooms\n\n- [Resource: Room](#Room)\n - [JSON representation](#Room.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: Room\n--------------\n\nRoom resource represents an instance of sub-space within a structure such as rooms in a hotel suite or rental apartment.\n\n| JSON representation |\n|--------------------------------------------------|\n| ``` { \"name\": string, \"traits\": { object } } ``` |\n\n| Fields ||\n|----------|-------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Output only. The resource name of the room. For example: \"enterprises/XYZ/structures/ABC/rooms/123\". |\n| `traits` | `object (`[Struct](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Struct)` format)` Room traits. |\n\n| Methods ------- ||\n|-------------------------------------------------------------------------------------|----------------------------------------|\n| ### [get](/nest/device-access/reference/rest/v1/enterprises.structures.rooms/get) | Gets a room managed by the enterprise. |\n| ### [list](/nest/device-access/reference/rest/v1/enterprises.structures.rooms/list) | Lists rooms managed by the enterprise. |"]]
