プレースを一覧表示するList places

名前空間: microsoft.graphNamespace: microsoft.graph

テナントで定義されている、指定された種類のプレースオブジェクトのコレクションを取得します。Get a collection of the specified type of place objects defined in the tenant. たとえば、すべてのルーム、すべての会議室の一覧、または、テナント内の特定の会議室一覧の会議室を取得できます。For example, you can get all the rooms, all the room lists, or the rooms in a specific room list in the tenant.

Placeオブジェクトには、次の種類のいずれかを指定できます。A place object can be one of the following types:

  • ルームには、会議室の電子メールアドレスなどの豊富なプロパティと、アクセシビリティ、容量、デバイスのサポートが含まれています。A room which includes rich properties such as an email address for the room, and accessibility, capacity, and device support.
  • 会議室リストのメールアドレスが含まれる会議室一覧と、会議室一覧の会議室のインスタンスのコレクションを取得するナビゲーションプロパティ。A room list which includes an email address for the room list, and a navigation property to get the collection of room instances in the room list.

RoomroomListの両方がplaceオブジェクトから派生します。Both room and roomList are derived from the place object.

既定では、この操作はページごとに100の場所を返します。By default, this operation returns 100 places per page.

この操作は、 Fin/omsおよびfin/omlists関数と比較して、ルームおよび会議室のリストに関する豊富なペイロードを返します。Compared with the findRooms and findRoomLists functions, this operation returns a richer payload for rooms and room lists. その違いについては、「詳細」を参照してください。See details for how they compare.

アクセス許可Permissions

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

アクセス許可の種類Permission type アクセス許可 (特権の小さいものから大きいものへ)Permissions (from least to most privileged)
委任 (職場または学校のアカウント)Delegated (work or school account) Place.Read.AllPlace.Read.All
委任 (個人用 Microsoft アカウント)Delegated (personal Microsoft account) サポートされていませんNot supported
アプリケーションApplication Place.Read.AllPlace.Read.All

HTTP 要求HTTP request

テナント内のすべてのルームを取得するには、次のようにします。To get all the rooms in a tenant:

GET /places/microsoft.graph.room

テナント内のすべての会議室一覧を取得するには、次のようにします。To get all the room lists in a tenant:

GET /places/microsoft.graph.roomlist

指定した会議室一覧のすべての会議室を取得するには、次のようにします。To get all the rooms in the specified room list:

GET /places/{room-list-emailaddress}/microsoft.graph.roomlist/rooms

: 会議室一覧の会議室を取得するには、そのidではなく、 emailAddressプロパティで会議室一覧を指定する必要があります。Note: To get rooms in a room list, you must specify the room list by its emailAddress property, not by its id.

省略可能なクエリ パラメーターOptional query parameters

このメソッドは、応答をカスタマイズするために、次のクエリパラメーターをサポートしています。This method supports the following query parameters to help customize the response:

  • $filter
  • $select
  • $top
  • $skip
  • $count=true

$topページサイズをカスタマイズするために使用します。Use $top to customize the page size. 既定のページ サイズは 100 です。The default page size is 100.

一般的な情報については、「 OData クエリパラメーター」を参照してください。For general information, see OData query parameters.

要求ヘッダーRequest headers

名前Name 説明Description
AuthorizationAuthorization ベアラー {トークン}。必須。Bearer {token}. Required.

要求本文Request body

このメソッドには、要求本文を指定しません。Do not supply a request body for this method.

応答Response

成功した場合、このメソッドは応答 200 OK コードと、応答本文でplaceオブジェクトのコレクションを返します。If successful, this method returns a 200 OK response code and a collection of place objects in the response body.

Examples

例 1: テナントで定義されているすべてのルームを一覧表示するExample 1: List all the rooms defined in the tenant

要求Request

次の例は、テナント内のすべてのroomオブジェクトを取得する方法を示しています。The following example shows how to get all the room objects in the tenant.

GET https://graph.microsoft.com/v1.0/places/microsoft.graph.room

応答Response

応答の例を次に示します。The following is an example of the response.

: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。Note: The response object shown here might be shortened for readability. 実際の呼び出しではすべてのプロパティが返されます。All the properties will be returned from an actual call.

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: テナントで定義されているすべての会議室一覧を一覧表示するExample 2: List all the room lists defined in the tenant

要求Request

次の例は、テナント内のすべてのroomListオブジェクトを取得する方法を示しています。The following example shows how to get all the roomList objects in the tenant.

GET https://graph.microsoft.com/v1.0/places/microsoft.graph.roomlist

応答Response

応答の例を次に示します。The following is an example of the response.

: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。Note: The response object shown here might be shortened for readability. 実際の呼び出しではすべてのプロパティが返されます。All the properties will be returned from an actual call.

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: ルームリストに含まれているルームのリストExample 3: List rooms contained in a room list

要求Request

次の例は、 roomListに含まれるroomオブジェクトの一覧を取得する方法を示しています。The following example shows how to get a list of room objects contained in a roomList.

GET https://graph.microsoft.com/v1.0/places/bldg2@contoso.com/microsoft.graph.roomlist/rooms

応答Response

応答の例を次に示します。The following is an example of the response.

: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。Note: The response object shown here might be shortened for readability. 実際の呼び出しではすべてのプロパティが返されます。All the properties will be returned from an actual call.

HTTP/1.1 200 OK
Content-type: application/json

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$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,
      "isManaged": true,
      "isWheelchairAccessible": false,
      "bookingType": "standard",
      "tags": [
        "benches",
        "nice view"
      ],
      "audioDeviceName": null,
      "videoDeviceName": null,
      "displayDevice": "surface hub"
    }
  ]
}