Partager via

todoTaskList : delta

  • Article

Espace de noms: microsoft.graph

Obtenez un ensemble de ressources todoTaskList qui ont été ajoutées, supprimées ou supprimées dans Microsoft To Do.

Un appel de fonction delta pour todoTaskList est similaire à une requête GET, sauf qu’en appliquant de manière appropriée des jetons d’état dans un ou plusieurs de ces appels, vous pouvez interroger les modifications incrémentielles dans todoTaskList. Cela vous permet de gérer et de synchroniser un magasin local de todoTaskList d’un utilisateur sans avoir à extraire tous les todoTaskList du serveur à chaque fois.

Cette API est disponible dans les déploiements de cloud national suivants.

Service global Gouvernement des États-Unis L4 Us Government L5 (DOD) Chine gérée par 21Vianet
✅ ✅ ✅ ❌

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Type d’autorisation Autorisations avec privilèges minimum Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire) Tasks.ReadWrite Non disponible.
Déléguée (compte Microsoft personnel) Tasks.ReadWrite Non disponible.
Application Tasks.Read.All Tasks.ReadWrite.All

Requête HTTP

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

Paramètres de requête

Le suivi des modifications apportées aux ressources todoTaskList entraîne une série d’appels de fonction delta . Si vous utilisez un paramètre de requête (autre que $deltatoken et $skiptoken), vous devez le spécifier dans la requête delta initiale. Microsoft Graph code automatiquement les paramètres spécifiés dans la partie jeton du @odata.nextLink ou de l’URL @odata.deltaLink fournie dans la réponse. Il vous suffit de spécifier les paramètres de requête de votre choix la première fois. Dans les requêtes suivantes, copiez et appliquez simplement l’URL @odata.nextLink ou @odata.deltaLink de la réponse précédente, car cette URL inclut déjà les paramètres encodés souhaités.

Paramètre de requête Type Description
$deltatoken string Jeton d’état retourné dans l’URL @odata.deltaLink de l’appel de fonction delta précédent pour la même collection todoTaskList , indiquant la fin de cette série de suivi des modifications. Enregistrez et appliquez l’ensemble de l’URL @odata.deltaLink, y compris ce jeton dans la première requête de la série suivante de suivi des modifications pour cette collection.
$skiptoken string Jeton d’état retourné dans l’URL @odata.nextLink de l’appel de fonction delta précédent, indiquant que d’autres modifications doivent être suivies dans la même collection todoTaskList .

Paramètres de requête OData

Vous pouvez utiliser un paramètre de requête $select comme dans toute requête GET pour spécifier uniquement les propriétés dont vous avez besoin pour de meilleures performances. La propriété id est toujours renvoyée.

En-têtes de demande

Nom Type Description
Autorisation string Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.
Content-Type string application/json. Obligatoire.
Préférence chaîne odata.maxpagesize={x}. Facultatif.

Réponse

Si elle réussit, cette méthode renvoie un code de réponse et un 200 OK objet de collection todoTaskList dans le corps de la réponse.

Exemple

Demande

L’exemple suivant montre comment effectuer un appel de fonction delta initial et limiter le nombre maximal de todoTaskList dans le corps de la réponse à 2.

Pour suivre les modifications apportées à todoTaskList, vous devez effectuer un ou plusieurs appels de fonction delta , avec les jetons d’état appropriés, pour obtenir l’ensemble des modifications incrémentielles depuis la dernière requête delta.

Les principales différences entre le suivi de todoTaskList et le suivi des ressources todoTask dans une liste se trouvent dans les URL de requête delta et les réponses de requête retournant les collections todoTaskList plutôt que todoTask .

GET https://graph.microsoft.com/v1.0/me/todo/lists/delta

Réponse

Si la requête est acceptée, la réponse inclut un jeton d’état qui est un skipToken
(dans un en-tête de réponse @odata.nextLink ) ou deltaToken (dans un en-tête de réponse @odata.deltaLink ). Respectivement, ils indiquent si vous devez poursuivre la ronde ou si vous avez terminé d’obtenir toutes les modifications pour cette ronde.

La réponse suivante illustre un skipToken dans un en-tête de réponse @odata.nextLink.

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

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

{
  "@odata.deltaLink":"https://graph.microsoft.com/v1.0/me/todo/lists/delta?$skiptoken=ldfdgdgfoT5csv4k99nvQqyku0jaGqMhc6XyFff5qQTQ7RJOr",
  "value": [
    {
      "@odata.etag":"W/\"4rfRVIPi9EqXgDbc8U7HGwADLLQ93w==\"",
         "displayName":"List1",
         "isOwner":true,
         "isShared":false,
         "wellknownListName":"none",
         "id":"AQMkADMwNTcyZjQzLTdkMGItNDdjMy04ZTYwLTJhYmUzNGI5ZD"
    }
  ]
}

Contenu connexe