場所を一覧表示する
名前空間: microsoft.graph
テナントで定義されている指定した種類の 場所 オブジェクトのコレクションを取得します。 たとえば、テナント内のすべての部屋、すべての会議室リスト、または特定の会議室リスト内の部屋を取得できます。
メモ: "GAL から非表示" とマークされている部屋は、このエンドポイントを介して取得できません。
place オブジェクトには、次のいずれかの型を指定できます。
- 会議室のメール アドレス、アクセシビリティ、容量、デバイスのサポートなど、豊富なプロパティを含む会議室。
- 会議室リストのメール アドレスと、会議室リスト内の会議室インスタンスのコレクションを取得するためのナビゲーション プロパティを含む会議室リスト。
room と roomList の両方が place オブジェクトから派生します。
既定では、この操作は 1 ページあたり 100 個の場所を返します。
findRooms 関数と findRoomLists 関数と比較して、この操作により、会議室と会議室リストのより豊富なペイロードが返されます。 比較方法の詳細を参照 してください 。
この API は、次の国内クラウド展開で使用できます。
グローバル サービス | 米国政府機関 L4 | 米国政府機関 L5 (DOD) | 21Vianet が運営する中国 |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
アクセス許可
この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「 アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、 アクセス許可のリファレンスを参照してください。
アクセス許可の種類 | 最小特権アクセス許可 | 特権の高いアクセス許可 |
---|---|---|
委任 (職場または学校のアカウント) | Place.Read.All | 注意事項なし。 |
委任 (個人用 Microsoft アカウント) | サポートされていません。 | サポートされていません。 |
アプリケーション | Place.Read.All | 注意事項なし。 |
HTTP 要求
テナント内のすべての部屋を取得するには:
GET /places/microsoft.graph.room
テナント内のすべての会議室リストを取得するには:
GET /places/microsoft.graph.roomlist
指定した会議室リスト内のすべての部屋を取得するには:
GET /places/{room-list-emailaddress}/microsoft.graph.roomlist/rooms
注: 会議室リストに会議室を取得するには、その ID ではなく emailAddress プロパティで会議室リストを指定する必要があります。
オプションのクエリ パラメーター
このメソッドは、応答のカスタマイズに役立つ次のクエリ パラメーターをサポートします。
$filter
$select
$top
$skip
$count=true
を使用して $top
ページ サイズをカスタマイズします。 既定のページ サイズは 100 です。
一般的な情報については、「OData クエリ パラメーター」を参照してください。
要求ヘッダー
名前 | 説明 |
---|---|
Authorization | ベアラー {token}。 必須です。 認証と承認の詳細については、こちらをご覧ください。 |
要求本文
このメソッドには、要求本文を指定しません。
応答
成功した場合、このメソッドは 200 OK
応答コードと、応答本文内の place オブジェクトのコレクションを返します。
例
例 1: テナントで定義されているすべての部屋を一覧表示する
要求
次の例は、テナント内のすべての ルーム オブジェクトを取得する方法を示しています。
GET https://graph.microsoft.com/v1.0/places/microsoft.graph.room
応答
次の例は応答を示しています。
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$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,
"isManaged": true,
"isWheelChairAccessible": false,
"bookingType": "standard",
"tags": [
"bean bags"
],
"audioDeviceName": null,
"videoDeviceName": null,
"displayDevice": "surface hub"
},
{
"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,
"isManaged": true,
"isWheelChairAccessible": false,
"bookingType": "standard",
"tags": [
"benches",
"nice view"
],
"audioDeviceName": null,
"videoDeviceName": null,
"displayDevice": "surface hub"
}
]
}
例 2: テナントで定義されているすべての会議室リストを一覧表示する
要求
次の例は、テナント内のすべての roomList オブジェクトを取得する方法を示しています。
GET https://graph.microsoft.com/v1.0/places/microsoft.graph.roomlist
応答
次の例は応答を示しています。
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$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"
},
{
"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"
}
]
}
例 3: 会議室リストに含まれる会議室を一覧表示する
要求
次の例は、roomList に含まれる会議室オブジェクトの一覧を取得する方法を示しています。
GET https://graph.microsoft.com/v1.0/places/Building2Rooms@contoso.com/microsoft.graph.roomlist/rooms
応答
次の例は応答を示しています。
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#places('Building2Rooms%40contoso.com')/microsoft.graph.roomList/rooms",
"value": [
{
"id": "f4119db7-9a33-4bfe-a387-4444b9e7fd54",
"displayName": "Conf Room Rainier",
"address": null,
"geoCoordinates": null,
"phone": "",
"nickname": "Conf Room Rainier",
"emailAddress": "Rainier@contoso.com",
"building": null,
"floorNumber": null,
"floorLabel": null,
"label": null,
"capacity": null,
"bookingType": "standard",
"audioDeviceName": null,
"videoDeviceName": null,
"displayDeviceName": null,
"isWheelChairAccessible": false,
"tags": []
},
{
"id": "42385a28-1a16-4043-8d84-07615656c4e3",
"displayName": "Conf Room Hood",
"address": null,
"geoCoordinates": null,
"phone": "",
"nickname": "Conf Room Hood",
"emailAddress": "Hood@contoso.com",
"building": null,
"floorNumber": null,
"floorLabel": null,
"label": null,
"capacity": null,
"bookingType": "standard",
"audioDeviceName": null,
"videoDeviceName": null,
"displayDeviceName": null,
"isWheelChairAccessible": false,
"tags": []
},
{
"id": "850ee91e-a154-4d87-928e-da04c788fd90",
"displayName": "Conf Room Baker",
"address": null,
"geoCoordinates": null,
"phone": "",
"nickname": "Conf Room Baker",
"emailAddress": "Baker@contoso.com",
"building": null,
"floorNumber": null,
"floorLabel": null,
"label": null,
"capacity": null,
"bookingType": "standard",
"audioDeviceName": null,
"videoDeviceName": null,
"displayDeviceName": null,
"isWheelChairAccessible": false,
"tags": []
}
]
}