フィードバック 編集

user: findRooms

  • [アーティクル]

名前空間: microsoft.graph

重要

Microsoft Graph のバージョンの /beta API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 API が v1.0 で使用できるかどうかを確認するには、 バージョン セレクターを使用します。

ユーザーのテナントまたは特定の部屋の一覧内にあるすべての会議室を表す emailAddressオブジェクトを取得します。

テナントは会議室を部屋の一覧に整理できます。 この API 内で、それぞれの会議室と部屋の一覧は、emailAddress インスタンスによって表されます。 テナント内のすべての部屋の一覧を取得できます。また、テナント内のすべての部屋を取得したり、または特定の部屋の一覧のすべての部屋を取得することができます。 テナント内の最初の 100 部屋まで取得できます。

アクセス許可

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。

アクセス許可の種類 アクセス許可 (特権の小さいものから大きいものへ)
委任 (職場または学校のアカウント) User.ReadBasic.All、User.Read.All
委任 (個人用 Microsoft アカウント) サポートされていません。
アプリケーション User.Read.All

HTTP 要求

テナント内のすべての部屋を取得するには、次のようにします。

GET /me/findRooms
GET /users/{id}/findRooms

テナントの特定の部屋の一覧にある部屋をすべて取得するには、次のようにします。

GET /me/findRooms(RoomList='{room_list_emailAddress}')
GET /users/{id}/findRooms(RoomList='{room_list_emailAddress}')

クエリ パラメーター

クエリ パラメーター 種類 説明
RoomList string 部屋の一覧に関連付けられている SMTP アドレス。それぞれの部屋の一覧は、SMTP アドレスを含んでいる emailAddress インスタンスによって表されます。

要求ヘッダー

名前 種類 説明
Authorization string ベアラー {token}。必須。
Content-Type string application/json. Required.

要求本文

このメソッドには、要求本文を指定しません。

応答

成功した場合、このメソッドは 200 OK 応答コードと、応答本文で emailAddress オブジェクトのコレクションを返します。

例

要求 1

最初の例では、サインインしているユーザーのテナントで定義されているすべての部屋を表す emailAddress オブジェクトを取得します。

GET https://graph.microsoft.com/beta/me/findRooms
応答 1

以下は、応答の例です。

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

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

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.emailAddress)",
    "value": [
        {
            "name": "Conf Room Adams",
            "address": "Adams@contoso.onmicrosoft.com"
        },
        {
            "name": "Conf Room Baker",
            "address": "Baker@contoso.onmicrosoft.com"
        },
        {
            "name": "Conf Room Crystal",
            "address": "Crystal@contoso.onmicrosoft.com"
        },
        {
            "name": "Conf Room Hood",
            "address": "Hood@contoso.onmicrosoft.com"
        },
        {
            "name": "Conf Room Rainier",
            "address": "Rainier@contoso.onmicrosoft.com"
        },
        {
            "name": "Conf Room Stevens",
            "address": "Stevens@contoso.onmicrosoft.com"
        }
    ]
}
要求 2

2 番目の例では、メール アドレス Building2Rooms@contoso.onmicrosoft.com で識別される特定の部屋の一覧の部屋を表す emailAddress オブジェクトを取得します。

GET https://graph.microsoft.com/beta/me/findRooms(RoomList='Building2Rooms@contoso.onmicrosoft.com')
応答 2

以下は、応答の例です。

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

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

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.emailAddress)",
    "value": [
        {
            "name": "Conf Room Baker",
            "address": "Baker@contoso.onmicrosoft.com"
        },
        {
            "name": "Conf Room Hood",
            "address": "Hood@contoso.onmicrosoft.com"
        },
        {
            "name": "Conf Room Rainier",
            "address": "Rainier@contoso.onmicrosoft.com"
        }
    ]
}