événement : delta

Espace de noms: microsoft.graph

Obtenez un ensemble de ressources d’événement ajoutées, supprimées ou mises à jour dans un ou plusieurs calendriers.

Vous pouvez obtenir des types spécifiques de ces changements incrémentiels dans les événements de tous les calendriers d’une boîte aux lettres ou d’un calendrier spécifique, ou dans une collection d’événements d’un calendarView (plage d’événements définie par les dates de début et de fin) d’un calendrier. Il peut s’agir du calendrier par défaut ou d’un autre calendrier spécifié appartenant à l’utilisateur. Lors de l’obtention de modifications incrémentielles sur calendarView, le calendrier peut également être un calendrier de groupe.

En règle générale, la synchronisation d’événements dans un affichage de calendrier ou de calendrier dans un magasin local implique une série d’appels de fonction delta multiples. L'appel initial est une synchronisation complète, et chaque appel delta ultérieur dans le même tour obtient les changements incrémentaux (ajouts, suppressions ou mises à jour). L’utilisation de deltas vous permet de maintenir et de synchroniser de façon incrémentielle un magasin local d’événements dans le calendrier spécifié.

Le tableau suivant répertorie les différences entre la fonction delta sur les événements et la fonction delta sur un calendarView dans un calendrier.

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

Autorisations

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

Requête HTTP

Cette section présente la syntaxe de requête HTTP pour l’appel de fonction delta initial afin de démarrer une synchronisation complète qui récupère tous les événements dans l’affichage de calendrier ou de calendrier spécifié. Cette syntaxe ne contient aucun jeton d’état.

L’URL de requête renvoyée dans une @odata.nextLink ou @odata.deltaLink d’une réponse réussie inclut un jeton d’état. Pour tout appel de fonction delta ultérieur, utilisez l’URL de la requête dans a @odata.nextLink ou @odata.deltaLink la précède.

Fonction delta sur les événements d’un calendrier utilisateur (préversion)

Appliquez la fonction delta à tous les événements ou événements démarrant à partir d’une date/heure spécifique, dans le ou les calendriers utilisateur spécifiés :

• Pour obtenir des modifications incrémentielles de tous les événements ou des événements commençant à la date/heure spécifiée ou après celle-ci dans la boîte aux lettres de l’utilisateur :

  GET /me/events/delta
  GET /users/{id | userPrincipalName}/events/delta
  
  GET /me/events/delta?startDateTime={start_datetime}
  GET /users/{id | userPrincipalName}/events/delta?startDateTime={start_datetime}
  

• Pour obtenir des modifications incrémentielles de tous les événements ou des événements commençant à la date/heure spécifiée dans le calendrier par défaut de l’utilisateur :

  GET /me/calendar/events/delta
  GET /users/{id | userPrincipalName}/calendar/events/delta
  
  GET /me/calendar/events/delta?startDateTime={start_datetime}
  GET /users/{id | userPrincipalName}/calendar/events/delta?startDateTime={start_datetime}
  

• Pour obtenir des modifications incrémentielles de tous les événements ou des événements commençant à la date/heure spécifiée dans le calendrier utilisateur spécifié :

  GET /me/calendars/{id}/events/delta
  GET /users/{id | userPrincipalName}/calendars/{id}/events/delta
  
  GET /me/calendars/{id}/events/delta?startDateTime={start_datetime}
  GET /users/{id | userPrincipalName}/calendars/{id}/events/delta?startDateTime={start_datetime}
  

• Pour obtenir des modifications incrémentielles, tous les événements ou des événements commençant à la date/heure spécifiée ou après celle-ci dans le groupe de calendriers et le calendrier spécifiés :

  GET /me/calendarGroups/{id}/calendars/{id}/events/delta
  GET /users/{id | userPrincipalName}/calendarGroups/{id}/calendars/{id}/events/delta
  
  GET /me/calendarGroups/{id}/calendars/{id}/events/delta?startDateTime={start_datetime}
  GET /users/{id | userPrincipalName}/calendarGroups/{id}/calendars/{id}/events/delta?startDateTime={start_datetime}
  

Fonction Delta sur l’affichage du calendrier dans un calendrier utilisateur

Appliquez la fonction delta à une plage d’événements délimités par la date/heure de début et de fin, dans le calendrier utilisateur spécifié :

• Pour obtenir des modifications incrémentielles dans un affichage Calendrier du calendrier par défaut de l’utilisateur :

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

• Pour obtenir des modifications incrémentielles dans un affichage Calendrier du calendrier utilisateur spécifié :

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

Fonction Delta sur l’affichage du calendrier dans un calendrier de groupe

• Pour obtenir des modifications incrémentielles dans un affichage Calendrier du calendrier d’un groupe :

  GET /groups/{id}/calendarView?startDateTime={start_datetime}&endDateTime={end_datetime}
  

Paramètres de requête

Le suivi des modifications entraîne une série d’un ou 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 @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 le @odata.nextLink ou l’URL @odata.deltaLink à partir de la réponse précédente, car cette URL inclut déjà les paramètres codés souhaités.

Paramètres de requête OData

• Attendez-vous à ce qu’un appel de fonction delta sur un calendarView retourne les mêmes propriétés que vous obtenez normalement à partir d’une GET /calendarView demande. Vous ne pouvez pas utiliser $select cette option pour obtenir uniquement un sous-ensemble de ces propriétés.

• La fonction delta ne prend pas en charge les paramètres de requête suivants pour les événements d’un calendrier utilisateur ou les événements d’un calendarView : $expand, ,$filter$orderby, $searchet .$select

En-têtes de demande

Réponse

Fonction Delta sur les événements (préversion)

En cas de réussite, cette méthode renvoie un 200 OK code de réponse et une collection d’événements dans le corps de la réponse. Chaque événement de la réponse contient uniquement les propriétés id, type, start et end pour des raisons de performances. Utilisez GET /events/{id} ultérieurement pour développer des événements à partir de la réponse.

Fonction Delta sur calendarView

En cas de réussite, cette méthode renvoie un 200 OK code de réponse et une collection d’événements dans le corps de la réponse.

Attendez-vous à obtenir toutes les propriétés que vous obtiendriez normalement d’une GET /calendarView demande.

Dans une série d’appels de fonction delta liés par la plage de dates d’un calendarView, vous pouvez parfois trouver un appel delta renvoyant deux types d’événements sous @removed la raison deleted:

• Événements qui se trouvent dans la plage de dates et qui ont été supprimés depuis l’appel delta précédent.
• Événements qui se trouvent en dehors de la plage de dates et qui ont été ajoutés, supprimés ou mis à jour depuis l’appel delta précédent.

Filtrez les @removed événements sous pour la plage de dates nécessaire à votre scénario.

Exemples

Exemple 1 : fonction delta sur les événements d’un calendrier (préversion)

Demande

L’exemple suivant présente la demande de synchronisation initiale pour obtenir les événements du calendrier par défaut de l’utilisateur connecté, qui se produisent le ou après le paramètre spécifié startDateTime . La demande initiale n’inclut aucun jeton d’état.

La demande utilise l’en-tête Prefer: odata.maxpagesize pour limiter le nombre maximal d’événements de chaque réponse à 1. Continuez à appeler la delta fonction à l’aide de la requête renvoyée @odata.nextLink jusqu’à ce que vous obteniez un @odata.deltaLink dans la réponse.

GET https://graph.microsoft.com/beta/me/calendar/events/delta?startDateTime=2020-06-12T00:00:00Z

Prefer: odata.maxpagesize=1

const options = {
	authProvider,
};

const client = Client.init(options);

let delta = await client.api('/me/calendar/events/delta?startDateTime=2020-06-12T00:00:00Z')
	.version('beta')
	.get();

Réponse

Si la demande réussit, 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 ). Respectivement, ils indiquent si vous devez continuer le tour ou si vous avez terminé d’obtenir tous les changements pour ce tour.

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

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

{
  "@odata.nextLink":"https://graph.microsoft.com/beta/me/calendar/events/delta?$skiptoken=R0usmcdvmMu7jxWP8",
  "value": [
    {
      "id": " AAMkADllMWMwNDkzLWJlY2EtNDIyOS1iZjAA=",
      "type": "singleInstance",
      "start": {
             "DateTime": "2020-02-19T10:00:00.0000000", 
             "TimeZone": "UTC"
         }, 
       "end": {
                "DateTime": "2020-02-19T11:00:00.0000000", 
                "TimeZone": "UTC"      
          } 
        }
  ]
}

Exemple 2 : Fonction Delta sur calendarView

Demande

L’exemple suivant présente la demande de synchronisation initiale pour obtenir les événements dans le calendrier spécifié de l’utilisateur connecté, dans la plage de dates indiquée par calendarView. La demande initiale n’inclut aucun jeton d’état.

La demande utilise l’en-tête Prefer: odata.maxpagesize pour limiter le nombre maximal d’événements de chaque réponse à 2. Continuez à appeler la delta fonction à l’aide de la requête renvoyée jusqu’à @odata.nextLink ce que vous obteniez tous les événements de cet affichage Calendrier et de A @odata.deltaLink dans la réponse.

GET https://graph.microsoft.com/beta/me/calendars/AAMkADI5M1BbeAAA=/calendarView/delta?startDateTime=2020-06-01T00:00:00Z&endDateTime=2020-06-10T00:00:00Z

Prefer: odata.maxpagesize=2

const options = {
	authProvider,
};

const client = Client.init(options);

let delta = await client.api('/me/calendars/AAMkADI5M1BbeAAA=/calendarView/delta?startDateTime=2020-06-01T00:00:00Z&endDateTime=2020-06-10T00:00:00Z')
	.version('beta')
	.get();

Réponse

Si la demande réussit, 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 ). Respectivement, ils indiquent si vous devez continuer le tour ou si vous avez terminé d’obtenir tous les changements pour ce tour.

La réponse suivante montre 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.context": "https://graph.microsoft.com/beta/$metadata#Collection(event)",
    "@odata.nextLink": "https://graph.microsoft.com/beta/me/calendars/AAMkADI5M1BbeAAA=/calendarView/delta?$skiptoken=R0usmcdvmMu7jxWP8",
    "value": [
        {
            "@odata.type": "#microsoft.graph.event",
            "@odata.etag": "W/\"Jdsb3FEkPk2qoUHCdliYowACwixTgw==\"",
            "createdDateTime": "2020-06-16T04:05:43.8668791Z",
            "lastModifiedDateTime": "2020-06-16T04:08:27.354268Z",
            "changeKey": "Jdsb3FEkPk2qoUHCdliYowACwixTgw==",
            "categories": [],
            "transactionId": null,
            "originalStartTimeZone": "Pacific Standard Time",
            "originalEndTimeZone": "Pacific Standard Time",
            "uid": "040000008200E00074C5B7101A82E00800000000F088B8B95843D601000000000000000010000000165CD5547CFC9545B6492B261750B48C",
            "reminderMinutesBeforeStart": 15,
            "isReminderOn": false,
            "hasAttachments": false,
            "subject": "Summer party",
            "bodyPreview": "",
            "importance": "normal",
            "sensitivity": "normal",
            "isAllDay": false,
            "isCancelled": false,
            "isOrganizer": true,
            "IsRoomRequested": false,
            "AutoRoomBookingStatus": "None",
            "responseRequested": true,
            "seriesMasterId": null,
            "showAs": "busy",
            "type": "singleInstance",
            "webLink": "https://outlook.office365.com/owa/?itemid=AAMkADI5MAAKkeE1QAAA%3D&exvsurl=1&path=/calendar/item",
            "onlineMeetingUrl": null,
            "isOnlineMeeting": false,
            "onlineMeetingProvider": "unknown",
            "allowNewTimeProposals": true,
            "OccurrenceId": null,
            "isDraft": false,
            "recurrence": null,
            "AutoRoomBookingOptions": null,
            "onlineMeeting": null,
            "id": "AAMkADI5MAAKkeE1QAAA=",
            "responseStatus": {
                "response": "none",
                "time": "0001-01-01T00:00:00Z"
            },
            "body": {
                "contentType": "html",
                "content": "<html>\r\n<head></head>\r\n<body lang=\"EN-US\" link=\"#0563C1\" vlink=\"#954F72\" style=\"\">\r\n<div class=\"WordSection1\">\r\n<p class=\"MsoNormal\">&nbsp;</p>\r\n</div>\r\n</body>\r\n</html>\r\n"
            },
            "start": {
                "dateTime": "2020-06-02T20:00:00.0000000",
                "timeZone": "UTC"
            },
            "end": {
                "dateTime": "2020-06-02T22:30:00.0000000",
                "timeZone": "UTC"
            },
            "location": {
                "displayName": "",
                "locationType": "default",
                "uniqueIdType": "unknown",
                "address": {
                    "type": "unknown"
                },
                "coordinates": {}
            },
            "locations": [],
            "attendees": [
                {
                    "type": "required",
                    "status": {
                        "response": "none",
                        "time": "0001-01-01T00:00:00Z"
                    },
                    "emailAddress": {
                        "name": "Samantha Booth",
                        "address": "samanthab@contoso.com"
                    }
                }
            ],
            "organizer": {
                "emailAddress": {
                    "name": "Samantha Booth",
                    "address": "samanthab@contoso.com"
                }
            }
        },
        {
            "@odata.type": "#microsoft.graph.event",
            "@odata.etag": "W/\"Jdsb3FEkPk2qoUHCdliYowACwixTfw==\"",
            "createdDateTime": "2020-06-16T04:06:18.386713Z",
            "lastModifiedDateTime": "2020-06-16T04:08:19.5694048Z",
            "changeKey": "Jdsb3FEkPk2qoUHCdliYowACwixTfw==",
            "categories": [],
            "transactionId": null,
            "originalStartTimeZone": "Pacific Standard Time",
            "originalEndTimeZone": "Pacific Standard Time",
            "uid": "040000008200E00074C5B7101A82E0080000000060074BC55843D6010000000000000000100000002D33A89F36B10D43A12FD990B62858B2",
            "reminderMinutesBeforeStart": 15,
            "isReminderOn": true,
            "hasAttachments": false,
            "subject": "Summer party part 2",
            "bodyPreview": "",
            "importance": "normal",
            "sensitivity": "normal",
            "isAllDay": false,
            "isCancelled": false,
            "isOrganizer": true,
            "IsRoomRequested": false,
            "AutoRoomBookingStatus": "None",
            "responseRequested": true,
            "seriesMasterId": null,
            "showAs": "busy",
            "type": "singleInstance",
            "webLink": "https://outlook.office365.com/owa/?itemid=AAMkADI5MAAKkeE1RAAA%3D&exvsurl=1&path=/calendar/item",
            "onlineMeetingUrl": null,
            "isOnlineMeeting": false,
            "onlineMeetingProvider": "unknown",
            "allowNewTimeProposals": true,
            "OccurrenceId": null,
            "isDraft": false,
            "recurrence": null,
            "AutoRoomBookingOptions": null,
            "onlineMeeting": null,
            "id": "AAMkADI5MAAKkeE1RAAA=",
            "responseStatus": {
                "response": "none",
                "time": "0001-01-01T00:00:00Z"
            },
            "body": {
                "contentType": "html",
                "content": "<html>\r\n<head></head>\r\n<body lang=\"EN-US\" link=\"#0563C1\" vlink=\"#954F72\" style=\"\">\r\n<div class=\"WordSection1\">\r\n<p class=\"MsoNormal\">&nbsp;</p>\r\n</div>\r\n</body>\r\n</html>\r\n"
            },
            "start": {
                "dateTime": "2020-06-04T19:30:00.0000000",
                "timeZone": "UTC"
            },
            "end": {
                "dateTime": "2020-06-04T22:30:00.0000000",
                "timeZone": "UTC"
            },
            "location": {
                "displayName": "",
                "locationType": "default",
                "uniqueIdType": "unknown",
                "address": {
                    "type": "unknown"
                },
                "coordinates": {}
            },
            "locations": [],
            "attendees": [
                {
                    "type": "required",
                    "status": {
                        "response": "none",
                        "time": "0001-01-01T00:00:00Z"
                    },
                    "emailAddress": {
                        "name": "Samantha Booth",
                        "address": "samanthab@contoso.com"
                    }
                }
            ],
            "organizer": {
                "emailAddress": {
                    "name": "Samantha Booth",
                    "address": "samanthab@contoso.com"
                }
            }
        }
    ]
}

Contenu connexe

• Requête delta Microsoft Graph
• Obtenir des modifications incrémentielles apportées à des événements dans un dossier