événement : deltaevent: delta

Obtenez un ensemble d’événements qui ont été ajoutés, supprimés ou mis à jour dans un calendarView (plage d’événements) du calendrier principal de l’utilisateur.Get a set of events that have been added, deleted, or updated in a calendarView (a range of events) of the user's primary calendar.

Un appel de fonction delta pour les événements est similaire à une requête GET /calendarview pour une plage de dates dans le calendrier principal de l’utilisateur, sauf que lorsque vous appliquez correctement des jetons d’état dans un ou plusieurs de ces appels, vous pouvez rechercher les modifications incrémentielles dans cet affichage Calendrier. Cela vous permet de mettre à jour et de synchroniser une collection locale d’événements d’un utilisateur dans le calendrier principal, sans avoir à récupérer l’ensemble des événements de ce calendrier depuis le serveur.A delta function call for events is similar to a GET /calendarview request for a range of dates in the user's primary calendar, except that by appropriately applying state tokens in one or more of these calls, you can query for incremental changes in that calender view. This allows you to maintain and synchronize a local store of a user's events in the primary calendar, without having to fetch all the events of that calendar from the server every time.

AutorisationsPermissions

L’une des autorisations suivantes est nécessaire pour appeler cette API. Pour plus d’informations, notamment sur la façon de choisir les autorisations, voir Autorisations.One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Type d’autorisationPermission type Autorisations (de celle qui offre le plus de privilèges à celle qui en offre le moins)Permissions (from least to most privileged)
Déléguée (compte professionnel ou scolaire)Delegated (work or school account) Calendars.ReadCalendars.Read
Déléguée (compte Microsoft personnel)Delegated (personal Microsoft account) Calendars.ReadCalendars.Read
ApplicationApplication Calendars.ReadCalendars.Read

Requête HTTPHTTP request

GET /me/calendarView/delta?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /users/{id}/calendarView/delta?startDateTime={start_datetime}&endDateTime={end_datetime}

Paramètres de requêteQuery parameters

Le suivi des modifications dans les événements entraîne une série d’un ou de plusieurs 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 le nextLink ou l’URL deltaLink à partir de la réponse précédente, car cette URL inclut déjà les paramètres codés souhaités.Tracking changes in events incurs a round of one or more delta function calls. If you use any query parameter (other than $deltatoken and $skiptoken), you must specify it in the initial delta request. Microsoft Graph automatically encodes any specified parameters into the token portion of the nextLink or deltaLink URL provided in the response. You only need to specify any desired query parameters once upfront. In subsequent requests, simply copy and apply the nextLink or deltaLink URL from the previous response, as that URL already includes the encoded, desired parameters.

Paramètre de requêteQuery parameter TypeType DescriptionDescription
startDateTimestartDateTime StringString La date et l’heure de début de la plage horaire, représentées au format ISO 8601. Par exemple, « 2015-11-08T19:00:00.0000000 ».The start date and time of the time range, represented in ISO 8601 format. For example, "2015-11-08T19:00:00.0000000".
endDateTimeendDateTime StringString La date et l’heure de fin de la plage horaire, représentées au format ISO 8601. Par exemple, « 2015-11-08T20:00:00.0000000 ».The end date and time of the time range, represented in ISO 8601 format. For example, "2015-11-08T20:00:00.0000000".
$deltatoken$deltatoken stringstring Jeton sur l’état renvoyé dans l’URL deltaLink de l’appel de fonction delta précédent pour le même affichage Calendrier, indiquant la fin de cette série de suivi de 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 cet affichage Calendrier.A state token returned in the deltaLink URL of the previous delta function call for the same calendar view, indicating the completion of that round of change tracking. Save and apply the entire deltaLink URL including this token in the first request of the next round of change tracking for that calendar view.
$skiptoken$skiptoken stringstring Jeton sur l’état renvoyé dans l’URL nextLink de l’appel de fonction delta précédent, indiquant que des modifications supplémentaires doivent être suivies dans le même affichage Calendrier.A state token returned in the nextLink URL of the previous delta function call, indicating there are further changes to be tracked in the same calendar view.

Lorsque vous effectuez une requête delta sur un affichage Calendrier, vous devriez obtenir toutes les propriétés que vous obtenez normalement d’une requête GET /calendarview. $select n’est pas pris en charge dans ce cas.When you do a delta query on a calendar view, expect to get all the properties you'd normally get from a GET /calendarview request. $select is not supported in this case.

En-têtes de demandeRequest headers

NomName TypeType DescriptionDescription
AutorisationAuthorization stringstring Porteur {token}. Obligatoire.Bearer {token}. Required.
Content-TypeContent-Type stringstring application/json. Obligatoire.application/json. Required.
PréférencePrefer chaînestring odata.maxpagesize={x}. Facultatif.odata.maxpagesize={x}. Optional.
PréférencePrefer chaînestring {Time zone}. Facultatif, format UTC utilisé si absente.{Time zone}. Optional, UTC assumed if absent.

RéponseResponse

Si elle réussit, cette méthode renvoie un code de réponse 200 OK et un objet de la collection event dans le corps de la réponse.If successful, this method returns a 200 OK response code and event collection object in the response body.

ExempleExample

DemandeRequest

L’exemple suivant montre comment effectuer un seul appel de fonction delta et limiter le nombre maximal d’événements dans le corps de réponse à 2.The following example shows how to make a single delta function call, and limit the maximum number of events in the response body to 2.

Pour effectuer le suivi des modifications dans une vue de calendrier, effectuez un ou plusieurs appels de fonction delta avec des jetons d’état appropriés, pour accéder à l’ensemble des modifications incrémentielles depuis la dernière requête delta.To track changes in a calendar view, you would make one or more delta function calls, with appropriate state tokens, to get the set of incremental changes since the last delta query.

GET https://graph.microsoft.com/v1.0/me/calendarView/delta?startdatetime={start_datetime}&enddatetime={end_datetime}

Prefer: odata.maxpagesize=2
RéponseResponse

Si la requête est acceptée, la réponse inclut un jeton d’état, qui est soit un skipToken (dans un en-tête de réponse _@odata.nextLink_) soit un deltaToken (dans un en-tête de réponse _@odata.deltaLink_). Ils indiquent respectivement si vous devez continuer avec la série ou si vous avez terminé d’accéder à toutes les modifications pour cette série.If the request is successful, the response would include a state token, which is either a skipToken (in an _@odata.nextLink_ response header) or a deltaToken (in an _@odata.deltaLink_ response header). Respectively, they indicate whether you should continue with the round or you have completed getting all the changes for that round.

La réponse suivante illustre un skipToken dans un en-tête de réponse _@odata.nextLink_.The response below shows a skipToken in an _@odata.nextLink_ response header.

Remarque : L’objet de réponse illustré ici peut être tronqué à des fins de concision. Toutes les propriétés sont renvoyées à partir d’un appel réel.Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

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

{
  "@odata.nextLink":"https://graph.microsoft.com/v1.0/me/calendarView/delta?$skiptoken={_skipToken_}",
  "value": [
    {
      "originalStartTimeZone": "originalStartTimeZone-value",
      "originalEndTimeZone": "originalEndTimeZone-value",
      "responseStatus": {
        "response": "response-value",
        "time": "datetime-value"
      },
      "iCalUId": "iCalUId-value",
      "reminderMinutesBeforeStart": 99,
      "isReminderOn": true
    }
  ]
}

Voir aussiSee also