Method: enterprises.structures.rooms.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists rooms managed by the enterprise.
HTTP request
GET https://smartdevicemanagement.googleapis.com/v1/{parent=enterprises/*/structures/*}/rooms
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
The parent resource name of the rooms requested. For example: "enterprises/XYZ/structures/ABC".
|
Request body
The request body must be empty.
Response body
Response message for SmartDeviceManagementService.ListRooms
If successful, the response body contains data with the following structure:
| JSON representation |
{
"rooms": [
{
object (Room)
}
]
} |
| Fields |
rooms[] |
object (Room)
The list of rooms.
|
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/sdm.service
For more information, see the OAuth 2.0 Overview.
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\u003eLists rooms managed by an enterprise within a specific structure.\u003c/p\u003e\n"],["\u003cp\u003eRequires an HTTP GET request to a structured URL containing the enterprise and structure IDs.\u003c/p\u003e\n"],["\u003cp\u003eAn empty request body is necessary, while the response provides a list of rooms in JSON format.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization is required using the \u003ccode\u003ehttps://www.googleapis.com/auth/sdm.service\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],["This document outlines the process for listing rooms within an enterprise using the Smart Device Management API. A `GET` request is sent to a specific URL containing the enterprise and structure identifiers in the `parent` path parameter. The request body must be empty. Successful requests return a JSON response containing a list of `rooms`, each detailed as an object. This action requires the `https://www.googleapis.com/auth/sdm.service` OAuth scope for authorization.\n"],null,["# Method: enterprises.structures.rooms.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListRoomsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Examples](#examples)\n\nLists rooms managed by the enterprise.\n\n### HTTP request\n\n`GET https://smartdevicemanagement.googleapis.com/v1/{parent=enterprises/*/structures/*}/rooms`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|----------------------------------------------------------------------------------------------------------|\n| `parent` | `string` The parent resource name of the rooms requested. For example: \"enterprises/XYZ/structures/ABC\". |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for SmartDeviceManagementService.ListRooms\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------|\n| ``` { \"rooms\": [ { object (/nest/device-access/reference/rest/v1/enterprises.structures.rooms#Room) } ] } ``` |\n\n| Fields ||\n|-----------|-----------------------------------------------------------------------------------------------------------------|\n| `rooms[]` | `object (`[Room](/nest/device-access/reference/rest/v1/enterprises.structures.rooms#Room)`)` The list of rooms. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/sdm.service`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2)."]]
