todoTask: delta

Namespace: microsoft.graph

Obtenha um conjunto de recursos todoTask que foram adicionados, excluídos ou atualizados em uma todoTaskList especificada.

Uma chamada de função delta para recursos todoTask em um todoTaskList é semelhante a uma solicitação GET, exceto que, ao aplicar adequadamente tokens de estado em uma ou mais dessas chamadas, você pode consultar alterações incrementais no todoTask nessa todoTaskList. Isso permite que você mantenha e sincronize um armazenamento local dos recursos todoTask de um usuário sem precisar buscar todo o conjunto do servidor todas as vezes.

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) Tasks.ReadWrite Tasks.Read
Delegado (conta pessoal da Microsoft) Tasks.ReadWrite Tasks.Read
Application Tasks.ReadWrite.All Tasks.Read.All

Solicitação HTTP

GET /me/todo/lists/{id}/tasks/delta
GET /users/{id|userPrincipalName}/todo/lists/{todoTaskListId}/tasks/delta

Parâmetros de consulta

O rastreamento de alterações em uma coleção todoTask 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 os parâmetros de consulta desejados antecipadamente. Em solicitações subsequentes, basta copiar e aplicar a @odata.nextLink URL ou @odata.deltaLink da resposta anterior, pois essa URL já inclui os parâmetros codificados e desejados.

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 todoTask, indicando a conclusão dessa rodada de controle de alterações. Salve e aplique toda a URL @odata.deltaLink, incluindo esse token na primeira solicitação da próxima série de controle de alterações desse conjunto.
$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 todoTask.

Parâmetros de consulta OData

  • Você pode usar um parâmetro de consulta $select como em qualquer solicitação GET para especificar somente as propriedades necessárias para obter melhor desempenho. A propriedade id sempre será retornada.
  • Suporte a $select$topconsulta delta e $expand para todoTask.
  • Há suporte limitado para $filter e $orderby:
    • As únicas expressões $filter com suporte são $filter=receivedDateTime+ge+{value} ou $filter=receivedDateTime+gt+{value}.
    • A única expressão $orderby suportada é $orderby=receivedDateTime+desc. Se você não incluir uma $orderby expressão, a ordem de devolução não será garantida.
  • Não há suporte para $search.

Cabeçalhos de solicitação

Nome Tipo Descrição
Autorização string {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type string application/json. Obrigatório.
Preferir cadeia de caracteres odata.maxpagesize={x}. Opcional.

Resposta

Se for bem-sucedido, esse método retornará um código de resposta e um 200 OK objeto de coleta todoTask no corpo da resposta.

Exemplo

Solicitação

Para acompanhar as alterações nos recursos todoTask em um todoTaskList desde a última rodada de controle de alterações, você faria uma ou mais chamadas de função delta para obter o conjunto de alterações incrementais. O exemplo a seguir mostra como iniciar uma próxima rodada de controle de alterações, usando a URL na @odata.deltaLink URL retornada da última chamada de função delta da última rodada, que contém um deltaToken. Essa chamada de função delta limita o número máximo de todoTask no corpo da resposta a 2.

GET https://graph.microsoft.com/v1.0/me/todo/lists/gDbc8U7HGwADDZocJgAAAA==/tasks/delta?$deltatoken=w0vf2jHg2mBXU-I2AK0FSWl0dopNtG8u5YoM

Resposta

Se a solicitação for bem-sucedida, a resposta incluiria um token de estado que é um skipToken
(em um cabeçalho de resposta @odata.nextLink ) ou um deltaToken (em um cabeçalho de resposta @odata.deltaLink ). Respectivamente, eles indicam se você deve continuar com a rodada ou se concluiu a obtenção de todas as alterações para essa rodada.

A resposta abaixo mostra um skipToken em um cabeçalho de resposta @odata.nextLink.

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

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

{
   "@odata.deltaLink":"https://graph.microsoft.com/v1.0/me/todo/lists/gDbc8U7HGwADDZocJgAAAA==/tasks/delta?$deltatoken=MoVMZ_DzHG4AhT3WE8VioVS1IXZJ-ArqK5fknOjnKFY",
   "value":[
      {
         "@odata.etag":"W/\"4rfRVIPi9EqXgDbc8U7HGwADLLQ9xQ==\"",
         "importance":"normal",
         "isReminderOn":false,
         "status":"notStarted",
         "title":"empty task3",
         "createdDateTime":"2020-08-12T04:54:29.1925206Z",
         "lastModifiedDateTime":"2020-08-12T04:54:29.4903939Z",
         "id":"AAMkADMwNTcyZjQzLTdkMGItNDdjMy04ZTYwLTJhYmUzNGI5ZDEwMwBGAAAAAAB5M0K0qlJySLOAgV22zPnuBwDit9FUg_L0SpeANtzxTscbAAMNmhwmAADit9FUg_L0SpeANtzxTscbAAMxlnrYAAA=",
         "body":{
            "content":"",
            "contentType":"text"
         }
      }
   ]
}