Répertorier les lieux
Espace de noms: microsoft.graph
Importante
Les API sous la version /beta
dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .
Obtient une collection du type spécifié d’objets place définis dans le locataire.
Vous pouvez effectuer les opérations suivantes pour un locataire donné :
- Répertorier toutes les salles.
- Répertorier tous les espaces de travail.
- Répertorier toutes les listes de salles.
- Répertorier les salles dans une liste de salles spécifique.
- Répertorier les espaces de travail dans une liste de salles spécifique.
Un objet place peut être de l’un des types suivants :
- Une salle, qui inclut des propriétés enrichies telles qu’une adresse e-mail pour la salle, et l’accessibilité, la capacité et la prise en charge des appareils.
- Un espace de travail, qui inclut des propriétés telles qu’une adresse e-mail pour l’espace de travail, ainsi que l’accessibilité et la capacité.
- RoomList, qui inclut une adresse e-mail pour la liste de salles et une propriété de navigation pour obtenir la collection d’instances de salle dans la liste des salles.
Les ressources room, workspace et roomList sont dérivées de l’objet place .
Par défaut, cette opération retourne jusqu’à 100 places par page.
Par rapport aux fonctions findRooms et findRoomLists , cette opération retourne une charge utile plus riche pour les salles et les listes de salles. Pour plus d’informations sur leur comparaison, consultez Utilisation de l’API places.
Cette API est disponible dans les déploiements de cloud national suivants.
Service global | Gouvernement des États-Unis L4 | Us Government L5 (DOD) | Chine gérée par 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Autorisations
Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.
Type d’autorisation | Autorisations avec privilèges minimum | Autorisations privilégiées plus élevées |
---|---|---|
Déléguée (compte professionnel ou scolaire) | Place.Read.All | Non disponible. |
Déléguée (compte Microsoft personnel) | Non prise en charge. | Non prise en charge. |
Application | Place.Read.All | Non disponible. |
Requête HTTP
Pour obtenir toutes les salles d’un locataire :
GET /places/microsoft.graph.room
Pour obtenir tous les espaces de travail d’un locataire :
GET /places/microsoft.graph.workspace
Pour obtenir toutes les listes de salles dans un locataire :
GET /places/microsoft.graph.roomlist
Pour obtenir toutes les salles de la liste de salles spécifiée :
GET /places/{room-list-emailaddress}/microsoft.graph.roomlist/rooms
Pour obtenir tous les espaces de travail dans la liste de salles spécifiée :
GET /places/{room-list-emailaddress}/microsoft.graph.roomlist/workspaces
Remarque : Pour obtenir des salles ou des espaces de travail dans une liste de salles, vous devez spécifier la liste de salles par sa propriété emailAddress , et non par son ID.
Paramètres facultatifs de la requête
Cette méthode prend en charge les paramètres de requête suivants pour personnaliser la réponse :
$filter
$select
$top
$skip
$count=true
Utilisez $top
pour personnaliser la taille de la page. La taille de page par défaut est 100.
Pour des informations générales, consultez paramètres de la requête OData.
En-têtes de demande
Nom | Description |
---|---|
Autorisation | Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation. |
Corps de la demande
N’indiquez pas le corps de la demande pour cette méthode.
Réponse
Si elle réussit, cette méthode renvoie un 200 OK
code de réponse et une collection d’objets de place dans le corps de la réponse.
Exemples
Exemple 1 : Répertorier toutes les salles définies dans le locataire
Demande
L’exemple suivant montre comment obtenir tous les objets de salle dans le locataire.
GET https://graph.microsoft.com/beta/places/microsoft.graph.room
Réponse
L’exemple suivant illustre la réponse.
Remarque : l’objet de réponse affiché ici peut être raccourci pour plus de lisibilité.
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"
}
]
}
Exemple 2 : Répertorier tous les espaces de travail définis dans le locataire
Demande
L’exemple suivant montre comment obtenir tous les objets d’espaces de travail dans le locataire.
GET https://graph.microsoft.com/beta/places/microsoft.graph.workspace
Réponse
L’exemple suivant illustre la réponse.
Remarque : l’objet de réponse affiché ici peut être raccourci pour plus de lisibilité.
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"
}
]
}
Exemple 3 : Répertorier toutes les listes de salles définies dans le locataire
Demande
L’exemple suivant montre comment obtenir tous les objets roomList dans le locataire.
GET https://graph.microsoft.com/beta/places/microsoft.graph.roomlist
Réponse
L’exemple suivant illustre la réponse.
Remarque : l’objet de réponse affiché ici peut être raccourci pour plus de lisibilité.
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"
}
]
}
Exemple 4 : Répertorier les salles contenues dans une liste de salles
Demande
L’exemple suivant montre comment obtenir une liste d’objets de salle contenus dans un roomList.
GET https://graph.microsoft.com/beta/places/bldg2@contoso.com/microsoft.graph.roomlist/rooms
Réponse
L’exemple suivant illustre la réponse.
Remarque : l’objet de réponse affiché ici peut être raccourci pour plus de lisibilité.
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"
}
]
}
Exemple 5 : Lister les espaces de travail contenus dans une liste de salles
Demande
L’exemple suivant montre comment obtenir une liste d’objets d’espace de travail contenus dans un roomList.
GET https://graph.microsoft.com/beta/places/bldg2@contoso.com/microsoft.graph.roomlist/workspaces
Réponse
L’exemple suivant illustre la réponse.
Remarque : l’objet de réponse affiché ici peut être raccourci pour plus de lisibilité.
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"
}
]
}