Compartilhar via


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 registos recentemente criados, atualizados ou eliminados num plano Planner sem ter de efetuar uma leitura completa de toda a coleção de recursos. Para obter detalhes, veja Utilizar a consulta delta para controlar as alterações nos dados do Microsoft Graph.

Esta API está disponível nas seguintes implementações de cloud nacionais.

Serviço global US Government L4 US Government L5 (DOD) China operada pela 21Vianet

Permissões

Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.

Tipo de permissão Permissões com menos privilégios Permissões com privilégios superiores
Delegado (conta corporativa ou de estudante) Tasks.Read Indisponível.
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application Tasks.Read.All Indisponível.

Solicitação HTTP

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

Parâmetros de consulta

As alterações de controlo incorrem numa ronda 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. Nos pedidos subsequentes, copie e aplique o @odata.nextLink URL ou @odata.deltaLink da resposta anterior. Esse URL já inclui os parâmetros codificados.

Parâmetro de consulta Tipo Descrição
$deltaToken string Um token de estado devolvido no @odata.deltaLink URL da chamada da função delta anterior para a mesma coleção de recursos, indicando a conclusão dessa ronda de controlo de alterações. Guarde e aplique todo @odata.deltaLink o URL, incluindo este token no primeiro pedido da próxima ronda de controlo de alterações para essa coleção.
$skipToken string Um token de estado devolvido no @odata.nextLink URL da chamada da função delta anterior, que indica que há mais alterações a serem registadas 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, esta função devolve um 200 OK código de resposta e uma coleção plannerBucket no corpo da resposta. A resposta também inclui um @odata.nextLink ou um @odata.deltaLink URL.

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

  • Um @odata.deltaLink URL no objeto de resposta indica que não são devolvidos mais dados sobre o estado existente do recurso. Mantenha e utilize o @odata.deltaLink URL para saber mais sobre as alterações ao recurso no futuro.

Para obter mais detalhes, veja Utilizar a consulta delta para controlar as alterações nos dados do Microsoft Graph. Para obter um exemplo que mostra como controlar as alterações feitas aos utilizadores, veja Obter alterações incrementais para os utilizadores.

Exemplos

O exemplo seguinte mostra um pedido 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\\"
    }
  ]
}