Remarque
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de vous connecter ou de modifier des répertoires.
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de modifier des répertoires.
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 de ressources de calendrier ajoutées, supprimées ou mises à jour dans un ou plusieurs calendriers.
En règle générale, la synchronisation des calendriers dans une boîte aux lettres dans un magasin local implique une série de plusieurs appels de fonction delta . 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 gérer et de synchroniser de façon incrémentielle un magasin local de calendriers dans la boîte aux lettres spécifiée.
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) | Calendars.Read | Calendars.ReadBasic, Calendars.ReadWrite |
| Déléguée (compte Microsoft personnel) | Calendars.Read | Calendars.ReadBasic, Calendars.ReadWrite |
| Application | Calendars.Read | Calendars.ReadBasic, Calendars.ReadWrite |
Requête HTTP
Pour commencer le suivi des modifications, vous effectuez une requête incluant la fonction delta sur la ressource calendara.
- Pour obtenir les modifications incrémentielles de la liste des calendriers dans la boîte aux lettres de l’utilisateur :
GET /me/calendars/delta
GET /users/{usersId}/calendars/delta
Paramètres de requête
Le suivi des modifications dans les groupes 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 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è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 liste de calendrier, indiquant la fin de cette série de suivi des modifications. Enregistrez et appliquez l’URL entière @odata.deltaLink , y compris ce jeton, dans la première requête de la série suivante de suivi des modifications pour cette liste de calendrier. |
| $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 liste de calendriers. |
Paramètres de requête OData
Cette méthode prend en charge les paramètres de requête OData facultatifs pour vous aider à personnaliser la réponse.
- Vous pouvez utiliser un paramètre de requête
$selectcomme dans toute requête GET pour spécifier uniquement les propriétés dont vous avez besoin pour de meilleures performances. - La fonction delta ne prend pas en charge les paramètres de requête suivants :
$expand,$filter,$orderby$search, et .$select
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. |
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 de calendriers dans le corps de la réponse.
Exemples
Demande
L’exemple suivant illustre une demande. Comme il n’existe aucun $select paramètre, un ensemble de propriétés par défaut est suivi et retourné.
GET https://graph.microsoft.com/beta/me/calendars/delta
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 poursuivre la ronde ou si vous avez terminé d’obtenir toutes les modifications pour cette ronde.
La réponse ci-dessous montre un deltaToken dans un en-tête de réponse @odata.deltaLink .
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(calendar)",
"value": [
{
"@odata.type": "#microsoft.graph.calendar",
"id": "AQMkADRhZThkMDVjLTJmNDctNDUyZC05YjA2LTI2YzRmMTIxOWJhZQBGAAADVDIMnvGkNkGo5_ASLe7iUQcAvXegGcyc-0O1dA1ftrtB6QAAAgEGAAAAvXegGcyc-0O1dA1ftrtB6QAAAUSwewAAAA==",
"name": "Calendar",
"color": "auto",
"hexColor": "",
"groupClassId": "0006f0b7-0000-0000-c000-000000000046",
"isDefaultCalendar": true,
"changeKey": "vXegGcyc/0O1dA1ftrtB6QAAAEO+6Q==",
"canShare": true,
"canViewPrivateItems": true,
"isShared": false,
"isSharedWithMe": false,
"canEdit": true,
"calendarGroupId": null,
"allowedOnlineMeetingProviders": [
"teamsForBusiness"
],
"defaultOnlineMeetingProvider": "teamsForBusiness",
"isTallyingResponses": true,
"isRemovable": false,
"owner": {
"name": "Samantha Booth",
"address": "samanthab@contoso.com"
}
},
{
"@odata.type": "#microsoft.graph.calendar",
"id": "AQMkADRhZThkMDVjLTJmNDctNDUyZC05YjA2LTI2YzRmMTIxOWJhZQBGAAADVDIMnvGkNkGo5_ASLe7iUQcAvXegGcyc-0O1dA1ftrtB6QAAAgEGAAAAvXegGcyc-0O1dA1ftrtB6QAAAU4pOwAAAA==",
"name": "Birthdays",
"color": "auto",
"hexColor": "",
"groupClassId": "0006f0b7-0000-0000-c000-000000000046",
"isDefaultCalendar": false,
"changeKey": "vXegGcyc/0O1dA1ftrtB6QAAAEzvog==",
"canShare": false,
"canViewPrivateItems": true,
"isShared": false,
"isSharedWithMe": false,
"canEdit": false,
"calendarGroupId": null,
"allowedOnlineMeetingProviders": [],
"defaultOnlineMeetingProvider": "unknown",
"isTallyingResponses": false,
"isRemovable": true,
"owner": {
"name": "Samantha Booth",
"address": "samanthab@contoso.com"
}
}
],
"@odata.deltaLink": "https://graph.microsoft.com/beta/me/calendars/delta?$deltatoken=LztZwWjo5IivWBhyxw5rAIPrk_3pGHcZr4U33FHo0HpyBLqdo9QZIWfEL4AW1jMLBmo-o1ybmYCWlzQ5elO2bEDejh9Z8kYv_z4nhmHoC5Y.7Wdj3MWiils6M--JMM9dMyiLCh-1he4AZCqBu-8i42o"
}