plannerBucket: delta

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.

Obtenha buckets recém-criados, atualizados ou excluídos em um Planner plano sem precisar executar uma leitura completa de toda a coleção de recursos. Para obter detalhes, consulte Usar a consulta delta para acompanhar as alterações nos dados do Microsoft Graph.

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

Serviço global Governo dos EUA L4 GOVERNO DOS EUA L5 (DOD) China operada pela 21Vianet

Permissões

Escolha a permissão ou as permissões marcadas como menos privilegiadas para essa API. Use uma permissão ou permissões privilegiadas mais altas 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 privilegiadas mais altas
Delegado (conta corporativa ou de estudante) Tasks.Read Indisponível.
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Aplicativo Tasks.Read.All Indisponível.

Solicitação HTTP

GET /planner/plans/{plan-id}/buckets/delta

Parâmetros de consulta

O acompanhamento de alterações incorre em uma rodada de uma ou mais chamadas de função delta . Se você usar qualquer parâmetro de consulta (diferente de $deltaToken e $skipToken), especifique-o na primeira solicitação delta. O Microsoft Graph codifica automaticamente todos os parâmetros especificados na parte do token da URL @odata.nextLink ou @odata.deltaLink fornecida na resposta. Você só precisa especificar uma vez antecipadamente os parâmetros de consulta desejados. Em solicitações subsequentes, copie e aplique a @odata.nextLink URL ou @odata.deltaLink da resposta anterior. Essa URL já inclui os parâmetros codificados.

Parâmetro de consulta Tipo Descrição
$deltaToken string Um token de estado retornado na @odata.deltaLink URL da chamada de função delta anterior para a mesma coleção de recursos, indicando a conclusão dessa rodada de rastreamento de alterações. Salve e aplique toda @odata.deltaLink a URL, incluindo esse token na primeira solicitação da próxima rodada de acompanhamento de alterações para essa coleção.
$skipToken string Um token de estado retornado na @odata.nextLink URL da chamada de função delta anterior, indicando que há outras alterações a serem rastreadas na mesma coleção de recursos.

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type application/json

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 200 OK código de resposta e uma coleção plannerBucket no corpo da resposta. A resposta também inclui uma @odata.nextLink ou uma @odata.deltaLink URL.

  • Uma @odata.nextLink URL no objeto de resposta indica páginas adicionais de dados a serem recuperadas na sessão. O aplicativo continua fazendo solicitações usando a URL @odata.nextLink até uma URL @odata.deltaLink ser incluída na resposta.

  • Uma @odata.deltaLink URL no objeto de resposta indica que não há mais dados sobre o estado existente do recurso retornados. Persista e use a @odata.deltaLink URL para saber mais sobre as alterações no recurso no futuro.

Para obter mais detalhes, confira Usar a consulta delta para acompanhar as alterações nos dados do Microsoft Graph. Para obter um exemplo que mostra como acompanhar as alterações nos usuários, confira Obter alterações incrementais para os usuários.

Exemplos

O exemplo a seguir mostra uma solicitação de delta em objetos plannerBucket contidos por um plannerPlan.

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/beta/planner/plans/-W4K7hIak0WlAwgJCn1sEWQABgjH/buckets/delta

Resposta

O exemplo a seguir mostra a resposta.

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

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

{
  "@odata.context":"https://graph.microsoft.com/beta/$metadata#plannerBucket",
  "@odata.deltaLink": "https://graph.microsoft.com/beta/planner/plans('-W4K7hIak0WlAwgJCn1sEWQABgjH')/buckets?deltatoken=0%257eaa6c4c81-656f-40e8-a2c5-60f4116fa9a4",
  "value": [
    {
      "@odata.etag": "W/\"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBASCc=\"",
      "id": "iz1mmIxX7EK0Yj7DmRsMs2QAEDXH",
      "name": "This is a bucket",
      "planId": "-W4K7hIak0WlAwgJCn1sEWQABgjH",
      "orderHint": "8585371316800245114P\\"
    }
  ]
}