Partager via

mailboxItem : delta

  • Article

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 mailboxItem qui ont été ajoutés, supprimés ou mis à jour dans un mailboxFolder spécifié.

Un appel de fonction delta pour les éléments d’un dossier 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 éléments de ce dossier. Cette approche vous permet de gérer et de synchroniser un magasin local des éléments de boîte aux lettres d’un utilisateur sans avoir à extraire l’ensemble des éléments du serveur à chaque fois.

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

Requête HTTP

GET /admin/exchange/mailboxes/{mailboxId}/folders/{mailboxFolderId}/items/delta

Paramètres de requête

Le suivi des modifications dans les éléments 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 nextLink ou de l’URL 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 nextLink ou 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 Description
$deltaToken Jeton d’état retourné dans l’URL deltaLink de l’appel de fonction delta précédent pour la même collection d’éléments, qui indique la fin de cette série de suivi des modifications. Enregistrez et appliquez l’ensemble de l’URL deltaLink, y compris ce jeton dans la première requête de la série suivante de suivi des modifications pour cette collection.
$skipToken Jeton d’état retourné dans l’URL nextLink de l’appel de fonction delta précédent, indiquant que d’autres modifications peuvent être suivies dans la même collection d’éléments.

Paramètres de requête OData

  • Vous pouvez utiliser le paramètre de $select requête pour spécifier uniquement les propriétés dont vous avez besoin pour des performances optimales. La propriété id est toujours renvoyée.
  • Cette requête delta prend en charge les paramètres de $select requête et $top pour les éléments.
  • La prise en charge est limitée pour $filter et $orderby:
    • Les seules expressions prises en charge $filter sont $filter=receivedDateTime+ge+{value} et $filter=receivedDateTime+gt+{value}.
    • La seule expression $orderby prise en charge est $orderby=receivedDateTime+desc. Si vous n’incluez pas d’expression $orderby , l’ordre de retour n’est pas garanti.
  • Le $search paramètre de requête n’est pas pris en charge.

En-têtes de demande

Nom Description
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.
Préférence odata.maxpagesize={x}. Facultatif.

Corps de la demande

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

Réponse

Si elle réussit, cette fonction renvoie un 200 OK code de réponse et une collection d’objets mailboxItem dans le corps de la réponse.

Exemples

Demande

L’exemple suivant montre comment effectuer un seul appel de fonction delta et limiter le nombre maximal d’éléments dans le corps de la réponse à deux.

Pour suivre les modifications apportées aux éléments d’un dossier, vous effectuez un ou plusieurs appels de fonction delta pour obtenir l’ensemble des modifications incrémentielles depuis la dernière requête delta.

Pour obtenir un exemple montrant une série d’appels de requête delta, consultez Obtenir des modifications incrémentielles d’éléments dans un dossier.

GET https://graph.microsoft.com/beta/admin/exchange/mailboxes/MBX:e0643f21@a7809c93/folders/AAMkAGUwNjQ4ZyTAAA=/items/delta
Prefer: odata.maxpagesize=2

Réponse

Si la demande réussit, la réponse inclut un jeton d’état qui est un $skipToken (dans un en-tête de réponse @odata.nextLink ) ou un $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.

L’exemple suivant montre un dans un $skipToken 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
Content-length: 337

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(mailboxItem)",
    "@odata.nextLink": "https://graph.microsoft.com/beta/admin/exchange/mailboxes/MBX:e0643f21@a7809c93/folders/AAMkAGUwNjQ4ZyTAAA=/items/delta?$skiptoken={_skipToken_}",
    "value": [
        {
            "@odata.type": "#microsoft.graph.mailboxItem",
            "@odata.etag": "W/\"CQAAABYAAACQ2fKdhq8oSKEDSVrdi3lRAAFR+6ZT\"",
            "createdDateTime": "2021-10-19T06:30:30Z",
            "lastModifiedDateTime": "2021-10-19T07:17:06Z",
            "changeKey": "CQAAABYAAACQ2fKdhq8oSKEDSVrdi3lRAAFR+6ZT",
            "categories": [],
            "type": "IPM.Note",
            "size": 75329,
            "id": "AAMkAGUwNjQ4ZyTAACQ2fKdhq8oSKEDSVrdi3lRAAFSX03WAAA="
        }
    ]
}

Contenu connexe