Вывод списка объектов размещения

Пространство имен: microsoft.graph

Получение коллекции указанного типа объектов place , определенных в клиенте.

Для данного клиента можно выполнить следующие действия:

Примечание.

  • Прежде чем использовать этот API, убедитесь, что параметры Places настроены правильно. Дополнительные сведения см. в разделе Предварительные требования для Places списка и потомков API.
  • По умолчанию эта операция возвращает до 100 комнат, рабочих областей и списков комнат на страницу, а также 1000 зданий, этажей, секций и столов на страницу.

Разрешения

Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.

Тип разрешения Разрешения с наименьшими привилегиями Более высокие привилегированные разрешения
Делегированные (рабочая или учебная учетная запись) Place.Read.All Place.ReadWrite.All
Делегированные (личная учетная запись Майкрософт) Не поддерживается. Не поддерживается.
Приложение Place.Read.All Place.ReadWrite.All

HTTP-запрос

Чтобы получить все расположения определенного типа в клиенте, выполните следующие действия:

GET /places/{placeType}

Примечание:{placeType} может быть любым поддерживаемым типом места, microsoft.graph.deskнапример .

Чтобы получить все комнаты в указанном списке комнат, выполните следующие действия:

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

Чтобы получить все рабочие области в указанном списке помещений, выполните следующие действия.

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

Примечание: Чтобы получить комнаты или рабочие области в списке комнат, необходимо указать список комнат по свойству emailAddress , а не по идентификатору.

Необязательные параметры запросов

Этот метод поддерживает следующие параметры запроса для настройки ответа:

  • $select
  • $top
  • $skip

Используйте $top для настройки размера страницы. Размер страницы по умолчанию — 100 для комнат, рабочих областей и списков комнат и 1000 для других.

Следующие параметры запроса поддерживаются только для комнаты, рабочей области и roomList:

  • $filter
  • $count=true

Общие сведения см. в статье Параметры запроса OData.

Заголовки запросов

Имя Описание
Авторизация Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации.

Текст запроса

Не указывайте текст запроса для этого метода.

Отклик

В случае успешного 200 OK выполнения этот метод возвращает код отклика и коллекцию объектов-мест в теле отклика.

Примеры

Пример 1. Перечисление всех зданий, определенных в клиенте

В следующем примере показано, как получить все объекты здания в клиенте.

Примечание. Свойство resourceLinks ресурса здания может вызвать проблемы с производительностью при выводе списка зданий. Эту проблему можно устранить, исключив свойство с помощью $select параметра запроса.

Запрос

Ниже показан пример запроса.

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

Отклик

Ниже показан пример отклика.

Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.

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

{
  "value": [
    {
      "id": "e18a8e21-0494-4296-a5bc-f848dba2740d",
      "placeId": "e18a8e21-0494-4296-a5bc-f848dba2740d",
      "displayName": "MRS",
      "phone": "8801733457",
      "isWheelChairAccessible": true,
      "label": "this is a building not open to all",
      "hasWiFi": false,
      "geoCoordinates": {
        "latitude": 31.2513263,
        "longitude": 121.3912291,
        "accuracy": null,
        "altitude": null,
        "altitudeAccuracy": null
      },
      "resourceLinks": []
    }
  ]
}

Пример 2. Перечисление всех этажей, определенных в клиенте

В следующем примере показано, как получить все объекты пола в клиенте.

Запрос

Ниже показан пример запроса.

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

Отклик

Ниже показан пример отклика.

Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.

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

{
  "value": [
    {
      "id": "c64205d0-1a2d-4cfe-9012-3f5d668d28ea",
      "placeId": "c64205d0-1a2d-4cfe-9012-3f5d668d28ea",
      "displayName": "Floor A",
      "parentId": "be7b53f1-7c63-4533-91d4-52c3ca856afb",
      "isWheelChairAccessible": false,
      "sortOrder": 1
    }
  ]
}

Пример 3. Перечисление всех разделов, определенных в клиенте

В следующем примере показано, как получить все объекты раздела в клиенте.

Запрос

Ниже показан пример запроса.

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

Отклик

Ниже показан пример отклика.

Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.

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

{
  "value": [
    {
      "id": "3e7160bb-75da-4456-ab3c-5ee061f4611a",
      "placeId": "3e7160bb-75da-4456-ab3c-5ee061f4611a",
      "displayName": "section_1",
      "parentId": "e30d4c71-95bf-4576-be4f-b6b7a8d2eeb7"
    }
  ]
}

Пример 4. Перечисление всех рабочих столов, определенных в клиенте

В следующем примере показано, как получить все объекты desk в клиенте.

Запрос

Ниже показан пример запроса.

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

Отклик

Ниже показан пример отклика.

Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.

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

{
  "value": [
    {
      "id": "530f7900-8063-4daf-9cc1-168cb3ac26e9",
      "placeId": "530f7900-8063-4daf-9cc1-168cb3ac26e9",
      "displayName": "desk 5",
      "parentId": "ca163ae1-14a3-4e2a-8a97-5f82d672186f",
      "isWheelChairAccessible": true,
      "mode": { "@odata.type": "#microsoft.graph.dropInPlaceMode" }
    }
  ]
}

Пример 5. Перечисление всех комнат, определенных в клиенте

В следующем примере показано, как получить все объекты комнаты в клиенте.

Запрос

Ниже показан пример запроса.

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,
      "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"
    }
  ]
}

Пример 6. Перечисление всех рабочих областей, определенных в клиенте

В следующем примере показано, как получить все объекты рабочей области в клиенте.

Запрос

Ниже показан пример запроса.

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

Отклик

Ниже показан пример отклика.

Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.

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

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$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"
    }
  ]
}

Пример 7. Перечисление всех списков помещений, определенных в клиенте

В следующем примере показано, как получить все объекты 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",
      "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"
    }
  ]
}

Пример 8. Перечисление комнат, содержащихся в списке комнат

В следующем примере показано, как получить список объектов комнаты , содержащихся в объекте roomList.

Запрос

Ниже показан пример запроса.

GET https://graph.microsoft.com/v1.0/places/bldg2@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('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"
    }
  ]
}

Пример 9. Перечисление рабочих областей, содержащихся в списке помещений

В следующем примере показано, как получить список объектов рабочей области , содержащихся в объекте roomList.

Запрос

Ниже показан пример запроса.

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

Отклик

Ниже показан пример отклика.

Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.

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/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"
    }
  ]
}