place: getOperation

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

Obtém um placeOperation por ID.

Observação

Os seguintes aspectos se aplicam quando você trabalha com essa API:

  • As operações são mantidas por 15 dias a partir da criação.
  • Limitação no nível da API:
    • Essa API tem um limite de limitação de três chamadas por segundo. Para obter mais informações, consulte Limites de limitação específicos do serviço do Microsoft Graph.
    • O progresso das operações de longa duração é atualizado a cada 30 segundos; Portanto, você não deve recuperar uma operação com mais frequência do que uma vez a cada 30 segundos.

Essa API está disponível nas seguintes implantações de nuvem nacional.

Serviço global Governo dos EUA L4 US Government L5 (DOD) China operada pela 21Vianet
✅ ✅ ✅ ❌

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

GET /places/getOperation(id='{id}')

Parâmetros de função

Na URL da solicitação, forneça os seguintes parâmetros de consulta com valores.

Parâmetro Tipo Descrição
id Cadeia de caracteres A ID da operação de local. Obrigatório.

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-sucedida, essa função retornará um código de 200 OK resposta e um objeto placeOperation no corpo da resposta.

Estrutura de detalhes da operação

Os detalhes da operação na resposta espelham a estrutura hierárquica do conteúdo da solicitação:

  • Cada local de nível superior na solicitação aparece como uma entrada de nível superior na matriz de detalhes , na mesma ordem que a solicitação.
  • A hierarquia especificada usando children@delta na solicitação é preservada na matriz filhos da resposta, na mesma ordem da solicitação.
  • Os locais criados ou atualizados com êxito são retornados na propriedade succeededPlace .
  • Todos os erros encontrados durante o processamento são retornados na propriedade de erro .

Exemplos

Exemplo 1: Obter uma operação bem-sucedida

O exemplo a seguir demonstra a resposta da operação para a solicitação de locais de upsert mostrada na seção de exemplo da API de locais de upsert. A estrutura de resposta espelha a hierarquia da solicitação, com cada local de nível superior da solicitação aparecendo na matriz de detalhes e locais filho aninhados nas matrizes filhas .

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/beta/places/getOperation(id='0f5d3cc5-d1bd-4cba-9b0e-e9ad68527ab5')

Resposta

O exemplo a seguir mostra a resposta.

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

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#microsoft.graph.placeOperation",
  "id": "0f5d3cc5-d1bd-4cba-9b0e-e9ad68527ab5",
  "status": "succeeded",
  "progress": {
    "totalPlaceCount": 9,
    "succeededPlaceCount": 9,
    "failedPlaceCount": 0
  },
  "details": [
    {
      "children": [
        {
          "succeededPlace": {
            "@odata.type": "#microsoft.graph.floor",
            "id": "5f54d496-7328-415a-930e-990be3a98766",
            "displayName": "Demo Floor 1",
            "parentId": "25e5905a-7fee-4f36-ba31-29e85c14bf18"
          }
        }
      ],
      "succeededPlace": {
        "@odata.type": "#microsoft.graph.building",
        "id": "25e5905a-7fee-4f36-ba31-29e85c14bf18",
        "displayName": "Demo Building A",
        "hasWiFi": true,
        "wifiState": "enabled"
      }
    },
    {
      "children": [
        {
          "children": [
            {
              "children": [
                {
                  "succeededPlace": {
                    "@odata.type": "#microsoft.graph.desk",
                    "id": "211ffb37-e880-475a-b73a-43f484609536",
                    "displayName": "desk1",
                    "parentId": "f5b54c22-5474-47aa-878a-0bfdc72e30f1",
                    "mode": {
                      "@odata.type": "#microsoft.graph.unavailablePlaceMode",
                      "reason": "New"
                    }
                  }
                },
                {
                  "succeededPlace": {
                    "@odata.type": "#microsoft.graph.room",
                    "id": "ddb3bfc7-c7af-40fb-a8be-26af40ee6cf3",
                    "placeId": "9112a87a-7994-4f73-9037-0939ef1c7d55",
                    "displayName": "Demo Room 1",
                    "parentId": "f5b54c22-5474-47aa-878a-0bfdc72e30f1",
                    "emailAddress": "DemoRoom19975d7971764579926925@contoso.onmicrosoft.com"
                  }
                }
              ],
              "succeededPlace": {
                "@odata.type": "#microsoft.graph.section",
                "id": "f5b54c22-5474-47aa-878a-0bfdc72e30f1",
                "displayName": "Demo Section A",
                "parentId": "23bfdc52-59d6-419d-ab18-54a51fe060f6"
              }
            }
          ],
          "succeededPlace": {
            "@odata.type": "#microsoft.graph.floor",
            "id": "23bfdc52-59d6-419d-ab18-54a51fe060f6",
            "displayName": "Demo Floor 1",
            "parentId": "15369a66-e9f4-4803-8e7e-fa6b811fbd92"
          }
        }
      ],
      "succeededPlace": {
        "@odata.type": "#microsoft.graph.building",
        "id": "15369a66-e9f4-4803-8e7e-fa6b811fbd92",
        "displayName": "Demo Building B"
      }
    },
    {
      "succeededPlace": {
        "@odata.type": "#microsoft.graph.workspace",
        "id": "8628af02-04c3-4882-88cc-06108de2d637",
        "placeId": "ebbc6ed0-8fda-41d2-9d07-c0f990337515",
        "displayName": "Demo Workspace 1",
        "parentId": "2cb2701d-0896-4c69-91bb-582d82d7c68c",
        "emailAddress": "DemoWorkspace1bb13cf171764579932835@contoso.onmicrosoft.com",
        "mode": {
          "@odata.type": "#microsoft.graph.reservablePlaceMode"
        }
      }
    },
    {
      "succeededPlace": {
        "@odata.type": "#microsoft.graph.section",
        "id": "2cb2701d-0896-4c69-91bb-582d82d7c68c",
        "displayName": "HR",
        "parentId": "94eb964a-b166-4f0a-953d-54dc9032d9d5"
      }
    }
  ]
}

Exemplo 2: Obter uma operação parcialmente bem-sucedida com erros

O exemplo a seguir mostra uma operação que foi parcialmente bem-sucedida.

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/beta/places/getOperation(id='116d12e4-3361-43f9-b722-af5b510760c9')

Resposta

O exemplo a seguir mostra a resposta com partiallySucceeded. A operação foi parcialmente bem-sucedida com um local criado e dois locais falharam.

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

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#microsoft.graph.placeOperation",
  "id": "15cc23bd-f215-42bf-92ad-bb84fbcd6606",
  "status": "partiallySucceeded",
  "progress": {
    "totalPlaceCount": 3,
    "succeededPlaceCount": 1,
    "failedPlaceCount": 2
  },
  "details": [
    {
      "error": null,
      "children": [
        {
          "error": {
            "code": "BadRequest",
            "message": "Requested Place not found: 881a74c1-a092-4f67-b354-174ca814df8b"
          }
        }
      ],
      "succeededPlace": {
        "@odata.type": "#microsoft.graph.building",
        "id": "25e5905a-7fee-4f36-ba31-29e85c14bf18",
        "displayName": "Demo Building 3"
      }
    },
    {
      "error": {
        "code": "BadRequest",
        "message": "A Place with the same name, type, parentId and address already exists with ID 9ba9753e-181a-471f-aa84-9ed238afae58."
      }
    }
  ]
}