Listar objetos de lugar

Namespace: microsoft.graph

Obtenha uma coleção do tipo especificado de objetos place definidos em um locatário.

Você pode fazer o seguinte para um determinado locatário:

Observação

  • Antes de usar essa API, verifique se as configurações do Places estão definidas corretamente. Para obter mais informações, consulte Pré-requisitos para listas de Places e APIs descendentes.
  • Por padrão, essa operação retorna até 100 salas, espaços de trabalho e listas de salas por página e 1.000 edifícios, andares, seções e mesas por página.

Permissões

Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Tipo de permissão Permissões menos privilegiadas Permissões com privilégios mais elevados
Delegado (conta corporativa ou de estudante) Place.Read.All Place.ReadWrite.All
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application Place.Read.All Place.ReadWrite.All

Solicitação HTTP

Para obter todos os locais de um tipo específico em um locatário:

GET /places/{placeType}

Observação:{placeType} pode ser qualquer tipo de local compatível, como microsoft.graph.desk.

Para obter todas as salas na lista de salas especificada:

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

Para obter todos os espaços de trabalho na lista de salas especificada:

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

Observação: Para obter salas ou espaços de trabalho em uma lista de salas, você deve especificar a lista de salas por sua propriedade emailAddress , não por sua id.

Parâmetros de consulta opcionais

Esse método dá suporte aos seguintes parâmetros de consulta para ajudar a personalizar a resposta:

  • $select
  • $top
  • $skip

Use $top para personalizar o tamanho da página. O tamanho de página padrão é 100 para salas, espaços de trabalho e listas de salas e 1.000 para outros.

Os seguintes parâmetros de consulta são suportados apenas para room, workspace e roomList:

  • $filter
  • $count=true

Para obter informações gerais, acesse Parâmetros de consulta OData.

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.

Corpo da solicitação

Não forneça um corpo de solicitação para esse método.

Resposta

Se for bem-sucedido, esse método retornará um 200 OK código de resposta e uma coleção de objetos place no corpo da resposta.

Exemplos

Exemplo 1: Listar todos os edifícios definidos no locatário

O exemplo a seguir mostra como obter todos os objetos de construção no locatário.

Nota: A propriedade resourceLinks do recurso de construção pode causar problemas de desempenho ao listar edifícios. Você pode atenuar esse problema excluindo a propriedade usando o $select parâmetro query.

Solicitação

O exemplo a seguir mostra uma solicitação.

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

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado com fins de legibilidade.

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": []
    }
  ]
}

Exemplo 2: Listar todos os andares definidos no locatário

O exemplo a seguir mostra como obter todos os objetos floor no locatário.

Solicitação

O exemplo a seguir mostra uma solicitação.

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

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado com fins de legibilidade.

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

Exemplo 3: Listar todas as seções definidas no locatário

O exemplo a seguir mostra como obter todos os objetos de seção no locatário.

Solicitação

O exemplo a seguir mostra uma solicitação.

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

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado com fins de legibilidade.

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

Exemplo 4: Listar todas as mesas definidas no locatário

O exemplo a seguir mostra como obter todos os objetos de mesa no locatário.

Solicitação

O exemplo a seguir mostra uma solicitação.

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

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado com fins de legibilidade.

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

Exemplo 5: Listar todas as salas definidas no locatário

O exemplo a seguir mostra como obter todos os objetos de sala no locatário.

Solicitação

O exemplo a seguir mostra uma solicitação.

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

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado com fins de legibilidade.

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

Exemplo 6: Listar todos os workspaces definidos no locatário

O exemplo a seguir mostra como obter todos os objetos de espaço de trabalho no locatário.

Solicitação

O exemplo a seguir mostra uma solicitação.

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

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado com fins de legibilidade.

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

Exemplo 7: Listar todas as listas de salas definidas no locatário

O exemplo a seguir mostra como obter todos os objetos roomList no locatário.

Solicitação

O exemplo a seguir mostra uma solicitação.

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

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado com fins de legibilidade.

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

Exemplo 8: Listar salas contidas em uma lista de salas

O exemplo a seguir mostra como obter uma lista de objetos de sala contidos em uma roomList.

Solicitação

O exemplo a seguir mostra uma solicitação.

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

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado com fins de legibilidade.

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

Exemplo 9: Listar espaços de trabalho contidos em uma lista de salas

O exemplo a seguir mostra como obter uma lista de objetos de espaço de trabalho contidos em uma roomList.

Solicitação

O exemplo a seguir mostra uma solicitação.

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

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado com fins de legibilidade.

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