remarque : delta

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Obtenez un ensemble d’objets de note qui ont été ajoutés, mis à jour ou supprimés dans le dossier Notes de l’utilisateur depuis la dernière requête delta. Un appel de fonction delta pour notes 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 les notes.

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) ShortNotes.Read ShortNotes.ReadWrite
Déléguée (compte Microsoft personnel) ShortNotes.Read ShortNotes.ReadWrite
Application Non prise en charge. Non prise en charge.

Requête HTTP

GET /me/notes/delta
GET /users/{id | userPrincipalName}/notes/delta

Paramètres de requête

Le suivi des modifications dans les notes 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 encode automatiquement tous les paramètres spécifiés dans la partie jeton de l’URL @odata.nextLink ou @odata.deltaLink fournie dans la réponse.

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, indiquant la fin de cette série de suivi des modifications. Enregistrez et appliquez l’intégralité 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 d’autres modifications à suivre.

Cette méthode prend également en charge les $selectparamètres de requête , $filter, $orderbyet $top OData pour vous aider à personnaliser la réponse.

En-têtes de demande

Nom Description
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.

Corps de la demande

N’indiquez pas le corps de la demande pour cette méthode.

Réponse

Si elle réussit, cette méthode renvoie un 200 OK code de réponse et une collection d’objets de note dans le corps de la réponse. La réponse inclut également une URL @odata.nextLink ou une URL @odata.deltaLink .

  • Si une URL @odata.nextLink est retournée, d’autres pages de données restent à récupérer. L’application continue d’effectuer des requêtes à l’aide de l’URL @odata.nextLink jusqu’à ce qu’une URL @odata.deltaLink soit incluse dans la réponse.
  • Si une URL @odata.deltaLink est retournée, il ne reste plus de pages de données à retourner. Enregistrez l’URL @odata.deltaLink à utiliser dans l’appel delta suivant.

Exemples

Exemple 1 : Demande de synchronisation initiale

L’exemple suivant montre la demande de synchronisation initiale pour obtenir toutes les notes.

Demande

L’exemple suivant illustre une demande.

GET https://graph.microsoft.com/beta/me/notes/delta

Réponse

L’exemple suivant illustre la réponse.

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

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#users('user-id')/notes",
  "@odata.deltaLink": "https://graph.microsoft.com/beta/me/notes/delta?$deltatoken=abc123def456",
  "value": [
    {
      "id": "AAMkAGI2THVSAAA=",
      "changeKey": "CQAAABYAAABE",
      "createdDateTime": "2024-01-15T10:00:00Z",
      "lastModifiedDateTime": "2024-01-20T11:00:00Z",
      "categories": [],
      "subject": "Updated Note",
      "body": {
        "contentType": "html",
        "content": "<html><body>Updated content</body></html>"
      },
      "bodyPreview": "Updated content",
      "isDeleted": false,
      "hasAttachments": false
    }
  ]
}

Exemple 2 : requête delta suivante

L’exemple suivant montre une demande de synchronisation suivante utilisant le jeton delta de la réponse précédente. Les notes nouvelles, mises à jour et supprimées sont retournées.

Demande

L’exemple suivant illustre une demande.

GET https://graph.microsoft.com/beta/me/notes/delta?$deltatoken=abc123def456

Réponse

L’exemple suivant illustre la réponse.

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

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#users('user-id')/notes",
  "@odata.deltaLink": "https://graph.microsoft.com/beta/me/notes/delta?$deltatoken=xyz789new",
  "value": [
    {
      "id": "AAMkAGI2NEWITEM=",
      "changeKey": "CQAAABYAAABF",
      "subject": "New Note",
      "bodyPreview": "New content",
      "createdDateTime": "2024-01-21T08:00:00Z",
      "lastModifiedDateTime": "2024-01-21T08:00:00Z"
    },
    {
      "@removed": {
        "reason": "deleted"
      },
      "id": "AAMkAGI2DELETED="
    }
  ]
}
  • Last updated on