Lugares de lista
Espacio de nombres: microsoft.graph
Importante
Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.
Obtenga una colección del tipo especificado de objetos place definidos en el inquilino.
Puede hacer lo siguiente para un inquilino determinado:
- Enumere todas las habitaciones.
- Enumere todas las áreas de trabajo.
- Enumera todas las listas de salas.
- Enumere las salas de una lista de habitaciones específica.
- Enumerar áreas de trabajo en una lista de salas específica.
Un objeto place puede ser uno de los siguientes tipos:
- Una habitación, que incluye propiedades enriquecidas, como una dirección de correo electrónico para la habitación, y accesibilidad, capacidad y compatibilidad con dispositivos.
- Un área de trabajo, que incluye propiedades como una dirección de correo electrónico para el área de trabajo, y accesibilidad y capacidad.
- RoomList, que incluye una dirección de correo electrónico para la lista de salas, y una propiedad de navegación para obtener la colección de instancias de sala en la lista de salas.
Los recursos room, workspace y roomList se derivan del objeto place .
De forma predeterminada, esta operación devuelve hasta 100 lugares por página.
En comparación con las funciones findRooms y findRoomLists , esta operación devuelve una carga más completa para las listas de salas y salas. Para obtener más información sobre cómo se comparan, consulte Uso de la API places.
Esta API está disponible en las siguientes implementaciones nacionales de nube.
| Servicio global | Gobierno de EE. UU. L4 | Us Government L5 (DOD) | China operada por 21Vianet |
|---|---|---|---|
| ✅ | ❌ | ❌ | ❌ |
Permissions
Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use un permiso o permisos con privilegios superiores solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.
| Tipo de permiso | Permisos con privilegios mínimos | Permisos con privilegios más altos |
|---|---|---|
| Delegado (cuenta profesional o educativa) | Place.Read.All | No disponible. |
| Delegado (cuenta personal de Microsoft) | No admitida. | No admitida. |
| Aplicación | Place.Read.All | No disponible. |
Solicitud HTTP
Para obtener todas las habitaciones de un inquilino:
GET /places/microsoft.graph.room
Para obtener todas las áreas de trabajo de un inquilino:
GET /places/microsoft.graph.workspace
Para obtener todas las listas de salas de un inquilino:
GET /places/microsoft.graph.roomlist
Para obtener todas las habitaciones de la lista de habitaciones especificada:
GET /places/{room-list-emailaddress}/microsoft.graph.roomlist/rooms
Para obtener todas las áreas de trabajo de la lista de salas especificada:
GET /places/{room-list-emailaddress}/microsoft.graph.roomlist/workspaces
Nota: Para obtener salas o áreas de trabajo en una lista de salas, debe especificar la lista de salas por su propiedad emailAddress , no por su identificador.
Parámetros de consulta opcionales
Este método admite los siguientes parámetros de consulta para ayudar a personalizar la respuesta:
$filter$select$top$skip$count=true
Use $top para personalizar el tamaño de página. El tamaño predeterminado de la página es 100.
Para obtener información general, vea Parámetros de consulta OData.
Encabezados de solicitud
| Nombre | Descripción |
|---|---|
| Authorization | {token} de portador. Obligatorio. Obtenga más información sobre la autenticación y la autorización. |
Cuerpo de la solicitud
No proporcione un cuerpo de solicitud para este método.
Respuesta
Si se ejecuta correctamente, este método devuelve un 200 OK código de respuesta y una colección de objetos place en el cuerpo de la respuesta.
Ejemplos
Ejemplo 1: Enumerar todas las salas definidas en el inquilino
Solicitud
En el ejemplo siguiente se muestra cómo obtener todos los objetos de sala del inquilino.
GET https://graph.microsoft.com/beta/places/microsoft.graph.room
Respuesta
En el ejemplo siguiente se muestra la respuesta.
Nota: se puede acortar el objeto de respuesta que se muestra aquí para mejorar la legibilidad.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#places/microsoft.graph.room",
"value": [
{
"id": "3162F1E1-C4C0-604B-51D8-91DA78989EB1",
"emailAddress": "cf100@contoso.com",
"displayName": "Conf Room 100",
"address": {
"street": "4567 Main Street",
"city": "Buffalo",
"state": "NY",
"postalCode": "98052",
"countryOrRegion": "USA"
},
"geoCoordinates": {
"latitude": 47.640568390488626,
"longitude": -122.1293731033803
},
"phone": "000-000-0000",
"nickname": "Conf Room",
"label": "100",
"capacity": 50,
"building": "1",
"floorNumber": 1,
"isWheelChairAccessible": false,
"bookingType": "standard",
"tags": [
"bean bags"
],
"audioDeviceName": null,
"videoDeviceName": null,
"displayDeviceName": "surface hub",
"placeId": "080ed1a0-7b54-4995-85a5-eeec751786f5"
},
{
"id": "3162F1E1-C4C0-604B-51D8-91DA78970B97",
"emailAddress": "cf200@contoso.com",
"displayName": "Conf Room 200",
"address": {
"street": "4567 Main Street",
"city": "Buffalo",
"state": "NY",
"postalCode": "98052",
"countryOrRegion": "USA"
},
"geoCoordinates": {
"latitude": 47.640568390488625,
"longitude": -122.1293731033802
},
"phone": "000-000-0000",
"nickname": "Conf Room",
"label": "200",
"capacity": 40,
"building": "2",
"floorNumber": 2,
"isWheelChairAccessible": false,
"bookingType": "standard",
"tags": [
"benches",
"nice view"
],
"audioDeviceName": null,
"videoDeviceName": null,
"displayDeviceName": "surface hub",
"placeId": "282c6d10-f8d4-441e-9f7f-edd2e554f61d"
}
]
}
Ejemplo 2: Enumerar todas las áreas de trabajo definidas en el inquilino
Solicitud
En el ejemplo siguiente se muestra cómo obtener todos los objetos workspaces del inquilino.
GET https://graph.microsoft.com/beta/places/microsoft.graph.workspace
Respuesta
En el ejemplo siguiente se muestra la respuesta.
Nota: se puede acortar el objeto de respuesta que se muestra aquí para mejorar la legibilidad.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#places/microsoft.graph.workspace",
"value": [
{
"id": "3162F1E1-C4C0-604B-51D8-91DA78989EB1",
"emailAddress": "ws100@contoso.com",
"displayName": "Workspace 100",
"address": {
"street": "4567 Main Street",
"city": "Buffalo",
"state": "NY",
"postalCode": "98052",
"countryOrRegion": "USA"
},
"geoCoordinates": {
"latitude": 47.640568390488626,
"longitude": -122.1293731033803
},
"phone": "000-000-0000",
"nickname": "Workspace",
"label": "100",
"capacity": 50,
"building": "1",
"floorNumber": 1,
"isWheelChairAccessible": false,
"tags": [
"bean bags"
],
"placeId": "357e8ddc-8af5-4c7c-bc38-ddb3bcfec0d9"
},
{
"id": "3162F1E1-C4C0-604B-51D8-91DA78970B97",
"emailAddress": "ws200@contoso.com",
"displayName": "Workspace 200",
"address": {
"street": "4567 Main Street",
"city": "Buffalo",
"state": "NY",
"postalCode": "98052",
"countryOrRegion": "USA"
},
"geoCoordinates": {
"latitude": 47.640568390488625,
"longitude": -122.1293731033802
},
"phone": "000-000-0000",
"nickname": "Workspace",
"label": "200",
"capacity": 40,
"building": "2",
"floorNumber": 2,
"isWheelChairAccessible": false,
"tags": [
"benches",
"nice view"
],
"placeId": "ca4e4ca8-4e92-4a83-afe4-5104c0ca1de3"
}
]
}
Ejemplo 3: Enumerar todas las listas de salas definidas en el inquilino
Solicitud
En el ejemplo siguiente se muestra cómo obtener todos los objetos roomList del inquilino.
GET https://graph.microsoft.com/beta/places/microsoft.graph.roomlist
Respuesta
En el ejemplo siguiente se muestra la respuesta.
Nota: se puede acortar el objeto de respuesta que se muestra aquí para mejorar la legibilidad.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#places/microsoft.graph.roomList",
"value": [
{
"id": "DC404124-302A-92AA-F98D-7B4DEB0C1705",
"displayName": "Building 1",
"address": {
"street": "4567 Main Street",
"city": "Buffalo",
"state": "NY",
"postalCode": "98052",
"countryOrRegion": "USA"
},
"geoCoordinates": null,
"phone": null,
"emailAddress": "bldg1@contoso.com",
"placeId": "406bd1b2-237c-4710-bda2-8b7900d61b27"
},
{
"id": "DC404124-302A-92AA-F98D-7B4DEB0C1706",
"displayName": "Building 2",
"address": {
"street": "4567 Main Street",
"city": "Buffalo",
"state": "NY",
"postalCode": "98052",
"countryOrRegion": "USA"
},
"geoCoordinates": null,
"phone": null,
"emailAddress": "bldg2@contoso.com",
"placeId": "25709e2a-4c17-49ab-b591-1daf8d9b786d"
}
]
}
Ejemplo 4: Enumerar salas contenidas en una lista de salas
Solicitud
En el ejemplo siguiente se muestra cómo obtener una lista de objetos room contenidos en roomList.
GET https://graph.microsoft.com/beta/places/bldg2@contoso.com/microsoft.graph.roomlist/rooms
Respuesta
En el ejemplo siguiente se muestra la respuesta.
Nota: se puede acortar el objeto de respuesta que se muestra aquí para mejorar la legibilidad.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#places('bldg2%40contoso.com')/microsoft.graph.roomList/rooms",
"value": [
{
"id": "3162F1E1-C4C0-604B-51D8-91DA78970B97",
"emailAddress": "cf200@contoso.com",
"displayName": "Conf Room 200",
"address": {
"street": "4567 Main Street",
"city": "Buffalo",
"state": "NY",
"postalCode": "98052",
"countryOrRegion": "USA"
},
"geoCoordinates": {
"latitude": 47.640568390488625,
"longitude": -122.1293731033802
},
"phone": "000-000-0000",
"nickname": "Conf Room",
"label": "200",
"capacity": 40,
"building": "2",
"floorNumber": 2,
"isWheelChairAccessible": false,
"bookingType": "standard",
"tags": [
"benches",
"nice view"
],
"audioDeviceName": null,
"videoDeviceName": null,
"displayDeviceName": "surface hub",
"placeId": "62cfc8cb-fc2b-4783-aeea-f9ce0f8e2904"
}
]
}
Ejemplo 5: Enumerar áreas de trabajo contenidas en una lista de salas
Solicitud
En el ejemplo siguiente se muestra cómo obtener una lista de objetos de área de trabajo contenidos en roomList.
GET https://graph.microsoft.com/beta/places/bldg2@contoso.com/microsoft.graph.roomlist/workspaces
Respuesta
En el ejemplo siguiente se muestra la respuesta.
Nota: se puede acortar el objeto de respuesta que se muestra aquí para mejorar la legibilidad.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#places('bldg2%40contoso.com')/microsoft.graph.roomList/workspaces",
"value": [
{
"id": "3162F1E1-C4C0-604B-51D8-91DA78970B97",
"emailAddress": "ws200@contoso.com",
"displayName": "Workspace 200",
"address": {
"street": "4567 Main Street",
"city": "Buffalo",
"state": "NY",
"postalCode": "98052",
"countryOrRegion": "USA"
},
"geoCoordinates": {
"latitude": 47.640568390488625,
"longitude": -122.1293731033802
},
"phone": "000-000-0000",
"nickname": "Workspace",
"label": "200",
"capacity": 40,
"building": "2",
"floorNumber": 2,
"isWheelChairAccessible": false,
"tags": [
"benches",
"nice view"
],
"placeId": "ca4e4ca8-4e92-4a83-afe4-5104c0ca1de3"
}
]
}
Comentarios
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea: https://aka.ms/ContentUserFeedback.
Enviar y ver comentarios de