Référence de l'API REST Calendrier pour Outlook (version 1.0)

Article
06/30/2018

Notes

La version 1.0 de l’API REST d'Outlook est actuellement déconseillée. À compter du 1er novembre 2018, les applications ne seront plus en mesure d’utiliser l'authentification de base avec la version 1.0 du point de terminaison REST. D’ici le 1er novembre 2019, la version 1.0 du point de terminaison REST sera complètement désactivée et la documentation de la version 1.0 sera supprimée peu de temps après. Commencez à migrer votre application pour utiliser l'API REST pour Outlook dans la version 1.0 de Microsoft Graph. Voir plus de détails dans notre annonce.

L’API Calendrier fournit un accès aux données d'événements, de calendrier et de groupe de calendriers sécurisées par Azure Active Directory sur Office 365, ainsi qu’à des données similaires dans les comptes Microsoft spécifiquement dans ces domaines : Hotmail.com, Live.com, MSN.com, Outlook.com, et Passport.com.

Notes

L’exception est l’API qui permet de trouver les heures de réunion et qui s’applique uniquement aux boîtes aux lettres Office 365 (sur Azure AD) et non aux comptes Microsoft.
Pour plus de simplicité, la suite de cet article utilise Outlook.com pour évoquer tous ces domaines de compte Microsoft.

La version 1.0 de l’API ne vous intéresse pas ? Dans la table des matières sur la gauche, accédez à la section Référence API REST pour Office 365 et sélectionnez la version souhaitée.

Toutes les opérations de l’API Calendrier

Opérations d'événement

Un événement correspond à un rendez-vous ou une réunion sur le calendrier de l’utilisateur. Un événement peut être le fait principal d'une série (pour les événements récurrents), une occurrence, une instance simple ou une exception.

Obtenir les événements
Synchroniser les événements
Créer des événements
Mettre à jour les événements
Répondre aux événements
Supprimer des événements
Obtenir les pièces jointes
Créer des pièces jointes
Supprimer les pièces jointes
Obtenir les rappels
Répéter les rappels
Ignorer les rappels

Opérations de calendrier

Un calendrier est l’objet dans lequel sont consignés les événements. Un utilisateur peut avoir plusieurs calendriers. Dans Office 365, chaque calendrier peut être affecté à un groupe de calendriers.

Obtenir les calendriers
Créer des calendriers
Mettre à jour les calendriers
Supprimer des calendriers

Opérations du groupe de calendriers

Les groupes de calendriers sont un moyen d'organiser plusieurs calendriers. Les utilisateurs peuvent ajouter plusieurs calendriers à un seul groupe de calendriers dans Outlook ou l’application web d'Outlook. Cela permet aux utilisateurs d’afficher plus rapidement tous les calendriers du groupe.

Notes

Outlook.com ne prend en charge que le groupe de calendriers par défaut, qui est accessible par le raccourci ../me/calendars. Vous ne pouvez pas supprimer ce groupe de calendriers ou en créer un autre.

Obtenir les groupes de calendriers
Créer des groupes de calendriers
Mettre à jour les groupes de calendriers
Supprimer des groupes de calendriers

Voir aussi

Utilisation de l’API REST Calendrier

Authentification

Comme pour les autres API REST Outlook, pour chaque demande envoyée à l’API Calendrier, vous devez inclure un jeton d’accès valide. Pour obtenir un jeton d’accès, vous devez avoir enregistré et identifié votre application et obtenu l’autorisation appropriée.

Vous pouvez en apprendre plus sur certaines options d’inscription et d’autorisation simplifiées pour vous. Gardez cela à l’esprit lorsque vous effectuez des opérations spécifiques dans l’API Calendrier.

Étendues pour accéder aux calendriers partagés

Les calendriers d’Office 365 et d’Outlook.com prennent en charge le partage. Un utilisateur qui a créé un calendrier peut le partager avec d'autres utilisateurs. Les étendues suivantes sont requises pour accéder à un agenda qui a été partagé avec l'utilisateur suivant :

Pour un accès en lecture : https://outlook.office.com/calendars.read.shared
Pour un accès en lecture/écriture : https://outlook.office.com/calendars.readwrite.shared

Version de l’API

L’API REST Calendrier est prise en charge dans toutes les versions de l’API REST Outlook. La fonctionnalité peut varier en fonction de la version spécifique.

Utilisateur cible

Les demandes de l’API Calendrier sont toujours effectuées au nom de l'utilisateur actuel.

Voir Utiliser l’API REST Outlook pour plus d’informations communes à tous les sous-ensembles de l’API REST Outlook.

Obtenir les événements

Obtenir un ensemble d’événements ou un événement.

Le corps de l'événement peut être au format texte ou HTML. Actuellement, l'opération GET renvoie les corps de l’événement uniquement au format HTML.

Obtenir une vue du calendrier
Obtenir les événements maître et les événements simples
Obtenir les instances de l’événement
Obtenir un événement

Obtenir une vue du calendrier

Étendue minimale requise

Un des éléments suivants :

https://outlook.office.com/calendars.read
wl.calendars
wl.contacts_calendars

Obtenez les occurrences, les exceptions, les instances simples d’événements dans la vue de calendrier définie par une plage de temps, ou à partir du calendrier principal de l’utilisateur (../me/calendarview) ou d’un autre calendrier.

GET https://outlook.office.com/api/v1.0/me/calendarview?start={start_datetime}&end={end_datetime}
GET https://outlook.office.com/api/v1.0/me/calendars/{calendar_id}/calendarview?startDateTime={start_datetime}&endDateTime={end_datetime}

Paramètre requis	Type	Description
Paramètres d'URL
calendar_id	chaîne	L’ID du calendrier, si vous utilisez une vue de calendrier d’un calendrier spécifique.
start_datetime	datetimeoffset	La date et l'heure auxquelles l'événement commence.
end_datetime	datetimeoffset	Date et heure de fin de l’événement.

Notes

Par défaut, chaque événement dans la réponse inclut toutes ses propriétés. Utilisez $select pour spécifier uniquement les propriétés dont vous avez besoin pour optimiser les performances. La propriété Id est toujours renvoyée. Voir Paramètres de requête OData pour les paramètres de filtrage, de tri et de pagination.

Par exemple, obtenez la vue du calendrier pour le mois d'octobre, en renvoyant uniquement la propriété Objet pour chaque événement :

GET https://outlook.office.com/api/v1.0/me/calendarview?startDateTime=2014-10-01T01:00:00Z&endDateTime=2014-10-31T23:00:00Z&$select=Subject

Type de réponse

Les événements étendus dans la plage de temps spécifiée.

Obtenir les événements maître et les événements simples

Étendue minimale requise

Un des éléments suivants :

https://outlook.office.com/calendars.read
wl.calendars
wl.contacts_calendars

Obtenir une collection d'événements principaux et d’instances d’évènements ponctuels à partir de l’agenda principal de l'utilisateur (../me/events) ou d’un agenda différent. Pour obtenir des instances d’événements étendus, vous pouvez afficher la vue de calendrier ou obtenir les instances d’un événement.

GET https://outlook.office.com/api/v1.0/me/events
GET https://outlook.office.com/api/v1.0/me/calendars/{calendar_id}/events

Paramètre requis	Type	Description
Paramètres d'URL
calendar_id	chaîne	L’ID du calendrier, si vous obtenez les événements à partir d’un calendrier spécifique.

Notes

Chaque événement dans la réponse inclut toutes ses propriétés. Utilisez $select pour spécifier uniquement les propriétés dont vous avez besoin pour optimiser les performances. La propriété Id est toujours renvoyée. Voir l'exemple suivant. Voir Paramètres de requête OData pour les paramètres de filtrage, de tri et de pagination.

L'exemple suivant montre comment utiliser $select pour spécifier que seules les propriétés Objet, Organisateur, Début et Fin de chaque événement doivent être renvoyées dans la réponse. Reportez-vous au premier exemple de réponse dans Obtenir un événement (REST) pour avoir une liste complète des propriétés qui seraient renvoyées pour un événement si vous n'utilisez pas $select.

Exemple de demande

GET https://outlook.office.com/api/v1.0/me/events?$select=Subject,Organizer,Start,End

Exemple de réponse

Code d’état : 200

{
    "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Events(Subject,Organizer,Start,End)",
    "value": [
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
            "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAA/LpDWw==\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAD8tEyDAAA=",
            "Subject": "Scrum",
            "Start": "2015-11-02T17:00:00Z",
            "End": "2015-11-02T17:30:00Z",
            "Organizer": {
                "EmailAddress": {
                    "Name": "user0TestUser",
                    "Address": "user0@a830edad9050849NDA1.onmicrosoft.com"
                }
            }
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
            "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAA/LpDWg==\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAD8tEyCAAA=",
            "Subject": "team lunch",
            "Start": "2015-11-02T00:00:00Z",
            "End": "2015-11-03T00:00:00Z",
            "Organizer": {
                "EmailAddress": {
                    "Name": "user0TestUser",
                    "Address": "user0@a830edad9050849NDA1.onmicrosoft.com"
                }
            }
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
            "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAAA0x49w==\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG93AAA=",
            "Subject": "Weekly Meeting on Contoso Project",
            "Start": "2014-10-13T21:00:00Z",
            "End": "2014-10-13T22:00:00Z",
            "Organizer": {
                "EmailAddress": {
                    "Name": "Alex D",
                    "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com"
                }
            }
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
            "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAAA0x49g==\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG92AAA=",
            "Subject": "Daily Team Meeting",
            "Start": "2014-10-13T18:00:00Z",
            "End": "2014-10-13T18:30:00Z",
            "Organizer": {
                "EmailAddress": {
                    "Name": "Alex D",
                    "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com"
                }
            }
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
            "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAAA0x47Q==\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG91AAA=",
            "Subject": "Rob:Alex 1:1",
            "Start": "2014-10-15T16:30:00Z",
            "End": "2014-10-15T17:30:00Z",
            "Organizer": {
                "EmailAddress": {
                    "Name": "Alex D",
                    "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com"
                }
            }
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
            "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAAA0x46g==\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG90AAA=",
            "Subject": "Thanksgiving Holiday",
            "Start": "2015-11-26T00:00:00Z",
            "End": "2015-11-27T00:00:00Z",
            "Organizer": {
                "EmailAddress": {
                    "Name": "Alex D",
                    "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com"
                }
            }
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
            "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAAA0x46Q==\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG9zAAA=",
            "Subject": "Thanksgiving Holiday",
            "Start": "2014-11-27T00:00:00Z",
            "End": "2014-11-28T00:00:00Z",
            "Organizer": {
                "EmailAddress": {
                    "Name": "Alex D",
                    "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com"
                }
            }
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
            "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAAA0x49Q==\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG9yAAA=",
            "Subject": "New Year's Day Holiday",
            "Start": "2015-01-01T00:00:00Z",
            "End": "2015-01-02T00:00:00Z",
            "Organizer": {
                "EmailAddress": {
                    "Name": "Alex D",
                    "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com"
                }
            }
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
            "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAAA0x45w==\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG9xAAA=",
            "Subject": "Christmas Holiday",
            "Start": "2014-12-25T00:00:00Z",
            "End": "2014-12-26T00:00:00Z",
            "Organizer": {
                "EmailAddress": {
                    "Name": "Alex D",
                    "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com"
                }
            }
        }
    ]
}

Obtenir les instances de l’événement

Étendue minimale requise

Un des éléments suivants :

https://outlook.office.com/calendars.read
wl.calendars
wl.contacts_calendars

Vous pouvez obtenir les instances (occurrences) d'un événement pour une plage de temps spécifiée. Si l’événement est du type SeriesMaster, cela renverra les occurrences et les exceptions de l'événement dans la plage de temps spécifiée.

GET https://outlook.office.com/api/v1.0/me/events/{event_id}/instances?startDateTime={start_datetime}&endDateTime={end_datetime}

Paramètre requis	Type	Description
Paramètres d'URL
event_id	chaîne	L’ID d’événement.
start_datetime	datetimeoffset	La date et l’heure auxquelles l’événement commence.
end_datetime	datetimeoffset	Date et heure UTC de la fin de l’événement.

Type de réponse

La collection d’ événements demandée.

Notes

Par exemple, pour obtenir les instances d’un événement particulier du mois d’octobre, incluez uniquement les propriétés Objet, Début et Fin de chaque instance :

GET https://outlook.office.com/api/v1.0/me/events/AAMkAGE0MGM1Y2M5LWEAAA=/instances?startDateTime=2014-10-01T01:00:00Z&endDateTime=2014-10-31T23:00:00Z&$select=Subject,Start,End

Obtenir un événement

Étendue minimale requise

Un des éléments suivants :

https://outlook.office.com/calendars.read
wl.calendars
wl.contacts_calendars

Obtenir un événement par ID.

GET https://outlook.office.com/api/v1.0/me/events/{event_id}

Paramètre requis	Type	Description
Paramètres d'URL
event_id	chaîne	L’ID d’événement.

Exemple de demande

GET https://outlook.office.com/api/v1.0/me/events/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG93AAA=

Exemple de réponse

Code d’état : 200

{
    "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Events/$entity",
    "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
    "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAAA0x49w==\"",
    "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG93AAA=",
    "DateTimeCreated": "2014-10-19T23:13:47.3959685Z",
    "DateTimeLastModified": "2014-10-23T20:23:47.0735997Z",
    "ChangeKey": "nfZyf7VcrEKLNoU37KWlkQAAA0x49w==",
    "Categories": [],
    "StartTimeZone": "Pacific Standard Time",
    "EndTimeZone": "Pacific Standard Time",
    "ResponseStatus": {
        "Response": "Organizer",
        "Time": "0001-01-01T00:00:00Z"
    },
    "iCalUId": "040000008200E00074C5B7101A82E0080000000005F3F755F2EBCF010000000000000000100000007547017C91509D42A5B60C97141AA3DD",
    "Reminder": 15,
    "HasAttachments": false,
    "Subject": "Weekly Meeting on Contoso Project",
    "Body": {
        "ContentType": "HTML",
        "Content": "<html>\r\n<head>\r\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\r\n</head>\r\n<body>\r\nSetting up some time to review the budget and planning on the Contoso Project\r\n</body>\r\n</html>\r\n"
    },
    "BodyPreview": "Setting up some time to review the budget and planning on the Contoso Project",
    "Importance": "Normal",
    "Sensitivity": "Normal",
    "Start": "2014-10-13T21:00:00Z",
    "End": "2014-10-13T22:00:00Z",
    "Location": {
        "DisplayName": "Alex's Office"
    },
    "IsAllDay": false,
    "IsCancelled": false,
    "IsOrganizer": true,
    "Recurrence": {
        "Pattern": {
            "Type": "Weekly",
            "Interval": 1,
            "Month": 0,
            "DayOfMonth": 0,
            "DaysOfWeek": [
                "Monday"
            ],
            "FirstDayOfWeek": "Sunday",
            "Index": "First"
        },
        "Range": {
            "Type": "NoEnd",
            "StartDate": "2014-10-13T00:00:00-07:00",
            "EndDate": "0001-01-01T00:00:00Z",
            "NumberOfOccurrences": 0
        }
    },
    "ResponseRequested": true,
    "SeriesMasterId": null,
    "ShowAs": "Busy",
    "Type": "SeriesMaster",
    "Attendees": [
        {
            "Status": {
                "Response": "None",
                "Time": "0001-01-01T00:00:00Z"
            },
            "Type": "Required",
            "EmailAddress": {
                "Name": "Janet Schorr",
                "Address": "janets@a830edad9050849NDA1.onmicrosoft.com"
            }
        },
        {
            "Status": {
                "Response": "None",
                "Time": "0001-01-01T00:00:00Z"
            },
            "Type": "Required",
            "EmailAddress": {
                "Name": "Pavel Bansky",
                "Address": "pavelb@a830edad9050849NDA1.onmicrosoft.com"
            }
        }
    ],
    "Organizer": {
        "EmailAddress": {
            "Name": "Alex D",
            "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com"
        }
    }

Type de réponse

L’événement demandé.

Notes

Par défaut, la réponse inclut toutes les propriétés de l’événement. Utilisez $select pour spécifier uniquement les propriétés dont vous avez besoin pour optimiser les performances. La propriété Id est toujours renvoyée. Voir Paramètres de requête OData pour les paramètres de filtrage, de tri et de pagination.

L’exemple suivant montre comment utiliser $select pour spécifier que seules les propriétés Objet, Organisateur, Début et Fin de l’événement doivent être renvoyées.

Exemple de demande

GET https://outlook.office.com/api/v1.0/me/events/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG93AAA=?$select=Subject,Organizer,Start,End

Exemple de réponse

{
    "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Events(Subject,Organizer,Start,End)/$entity",
    "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
    "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAAA0x49w==\"",
    "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG93AAA=",
    "Subject": "Weekly Meeting on Contoso Project",
    "Start": "2014-10-13T21:00:00Z",
    "End": "2014-10-13T22:00:00Z",
    "Organizer": {
        "EmailAddress": {
            "Name": "Alex D",
            "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com"
        }
    }
}

Synchroniser les événements

Étendue minimale requise

Un des éléments suivants :

https://outlook.office.com/calendars.read
wl.calendars
wl.contacts_calendars

Synchronisez et obtenez des événements récents, mis à jour ou supprimés dans une plage de temps spécifié à partir de l’agenda principal de l’utilisateur (../me/calendarview) ou d’un agenda différent. Une telle série d'événements comprisedans une plage de temps est également appelé une vue de l’agenda. Les événements renvoyés peuvent inclure des occurences et des exceptions d'une série récurrente et des instances d’événements ponctuels.

La synchronisation d'une vue de calendrier nécessite généralement une série de deux demandes de synchronisation ou plus, chacune étant un appel GET. Pour synchroniser une vue de calendrier, utilisez la méthode GET comme vous le faites pour obtenir une vue de calendrier, sauf que vous devez ici inclure certains en-têtes de demande, et un un deltaToken ou un skipToken, le cas échéant.

En-têtes de demande

Vous devez spécifier l'en-tête « Prefer: odata.track-changes » dans toutes les demandes de synchronisation, sauf pour celles qui incluent un skipToken qui est renvoyé par une précédente demande de synchronisation. Dans la première réponse, cherchez l’en-tête Preference-Applied: odata.track-changes pour confirmer que la ressource prend en charge la synchronisation avant de continuer. (Plus d’informations à propos de skipToken dans l’exemple de données de deuxième réponse ci-dessous)
Vous pouvez spécifier l'en-tête " Prefer: odata.maxpagesize = {x} " pour indiquer le nombre maximal d'événements renvoyés par la demande de synchronisation.

Voici une séquence typique d'événements de synchronisation dans une vue de calendrier :

Faites la première demande GET avec l’en-tête Prefer: odata.track-changes obligatoire. La réponse initiale à une requête de synchronisation renvoie toujours un deltaToken. (Les requêtes GET suivantes diffèrent de la première requête GET car elles incluent soit un deltaToken soit un skipToken reçu dans une réponse antérieure.)
Si la première réponse renvoie l'en-tête Preference-Applied: odata.track-changes, vous pouvez poursuivre la synchronisation.
- Faites une deuxième demande GET. Spécifiez l’en-tête Prefer: odata.track-changes et le deltaToken renvoyé par le premier GET pour déterminer s’il existe des événements supplémentaires. La deuxième demande renverra des événements supplémentaires, et soit un skipToken s'il y a plus d’autres événements disponibles, soit un deltaToken si le dernier événement a été synchronisé. Dans ce cas, vous pouvez vous arrêter.
- Poursuivre la synchronisation en envoyant un appel GET et en incluant un skipToken qui a été renvoyé par un appel précédent. Arrêtez lorsque vous obtenez une dernière réponse contenant de nouveau un en-tête @odata.deltaLink avec un deltaToken, ce qui indique que la synchronisation est terminée.

Examinez la syntaxe pour les appels initiaux et suivants dans une séquence de synchronisation.

Pour synchroniser dans le calendrier par défaut

Première demande :

GET https://outlook.office.com/api/v1.0/{user_context}/calendarview?startDateTime={start_datetime}&endDateTime={end_datetime}

Deuxième demande, ou première demande d’une séquence suivante :

GET https://outlook.office.com/api/v1.0/{user_context}/calendarview?startDateTime={start_datetime}&endDateTime={end_datetime}&$deltatoken={delta_token}

Troisième demande ou demande suivante dans la même séquence :

GET https://outlook.office.com/api/v1.0/{user_context}/calendarview?startDateTime={start_datetime}&endDateTime={end_datetime}&$skiptoken={skip_token}

Pour synchroniser dans un calendrier spécifique

Première demande :

GET https://outlook.office.com/api/v1.0/{user_context}/calendars('{calendar_id}')/calendarview?startDateTime={start_datetime}&endDateTime={end_datetime}

Deuxième demande, ou première demande d’une séquence suivante :

GET https://outlook.office.com/api/v1.0/{user_context}/calendars('{calendar_id}')/calendarview?startDateTime={start_datetime}&endDateTime={end_datetime}&$deltatoken={delta_token}

Troisième demande ou demande suivante dans la même séquence :

GET https://outlook.office.com/api/v1.0/{user_context}/calendars('{calendar_id}')/calendarview?startDateTime={start_datetime}&endDateTime={end_datetime}&$skiptoken={skip_token}

Paramètres

Paramètre	Type	Description
Paramètres d'URL
user_context	chaîne	Le contexte de l'utilisateur. Vous pouvez utiliser la valeur de ' moi ' pour indiquer le contexte de l'utilisateur actuel. Vous pouvez également utiliser le format users/{upn} où upn est le nom principal de l'utilisateur, ce qui correspond généralement à l'adresse e-mail de l'utilisateur.
calendar_id	chaîne	L’ID du calendrier, si vous utilisez une vue de calendrier d’un calendrier spécifique.
start_datetime	datetimeoffset	La date et l'heure auxquelles l'événement commence.
end_datetime	datetimeoffset	Date et heure de fin de l’événement.
delta_token	chaîne	La chaîne `deltaToken` renvoyée comme faisant partie de la valeur de @odata.deltaLink dans la précédente réponse de synchronisation.
skip_token	chaîne	La chaîne `skipToken` renvoyée comme faisant partie de la valeur de @odata.nextLink dans la précédente réponse de synchronisation.

Notes

Lorsque vous spécifiez « Prefer: odata.track-changes » dans la première demande, si la réponse prend en charge la synchronisation, la réponse inclura « Preference-applied: odata.track-changes » dans l'en-tête.
Si vous tentez de synchroniser une ressource non prise en charge ou si ce n’est pas la demande de synchronisation initiale, vous ne verrez pas l’en-tête " Preference-applied " dans la réponse
Vous pouvez modifier la fenêtre de modification de l'heure en modifiant les paramètres de requête startdatetime et enddatetime.
Par défaut, chaque message dans la réponse inclut toutes ses propriétés.
Pour une série récurrente, une réponse de synchronisation inclut l'événement entier englobant l’événement principal récurrent et les événements exceptionnels.
Les exemples d’une série récurrente sont abrégées et ne contiennent que les propriétés Début et Fin. Vous pouvez capturer le reste des informations de l’occurence d’un événement à partir de l’événement principal récurrent. Voir Ressource d'événement pour consulter les informations de référence.
Vous ne pouvez pas utiliser les paramètres $filter, $count, $select, $skip, $top, et $search requête.

Type de réponse

Les événements étendus et les événements abrégés dans la plage de temps spécifiée.

Exemple

L'exemple suivant montre les première et deuxième demandes de synchronisation pour synchroniser le calendrier par défaut pour l’utilisateur. Chaque demande spécifie de renvoyer un seul événement complet à la fois :

La première réponse renvoie un événement, un deltaLink et un deltaToken.
La deuxième demande utilise ce deltatoken. La deuxième réponse renvoie un événement, un nextLink et un skipToken.

Pour achever la synchronisation, utilisez le skipToken renvoyé par la demande de synchronisation précédente jusqu’à ce que la réponse de synchronisation renvoie un deltaLink et un deltaToken. Dans ce cas, cette séquence de synchronisation est terminée. Enregistrez le deltaToken pour la séquence de synchronisation suivante.

Pour plus d'informations, voir Synchroniser les événements dans une vue de calendrier Outlook.

Exemple de première demande

    GET https://outlook.office.com/api/v1.0/me/calendarview?startdatetime=2015-01-01T00:00:00Z&enddatetime=2015-04-10T00:00:00Z HTTP/1.1
    Authorization: Bearer <token>
    Prefer: odata.track-changes
    Prefer: odata.maxpagesize=1

Exemple de données d'une première réponse

Preference-Applied: odata.track-changes

    {
        "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/CalendarView",
        "value": [
            {
                "@odata.id": "https://outlook.office.com/api/v1.0/Users('user0@contoso.com')/Events('asdas==')",
                "@odata.etag": "W/\"L8Z+4Y4u7k+97uRKg==\"",
                "Id": "AQMkANJAAAAA==",
                "ChangeKey": "L8Z+AAAAARKg==",
                "Categories": [
                ],
                "DateTimeCreated": "2015-04-10T17:54:49.2725912Z",
                "DateTimeLastModified": "2015-04-10T17:54:49.3038538Z",
                "Subject": "Discuss the Calendar REST API",
                "BodyPreview": "I think it will meet our requirements!",
                "Body": {
                    "ContentType": "HTML",
                    "Content": "<html>\r\n<head>\r\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\r\n</head>\r\n<body>\r\nI think it will meet our requirements!\r\n</body>\r\n</html>\r\n"
                },
                "Importance": "Normal",
                "HasAttachments": false,
                "Start": "2015-04-05T18:00:00Z",
                "StartTimeZone": "Pacific Standard Time",
                "End": "2015-04-05T19:00:00Z",
                "EndTimeZone": "Pacific Standard Time",
                "Reminder": 15,
                "Location": {
                    "DisplayName": "",
                    "Address": null
                },
                "ResponseStatus": {
                    "Response": "Organizer",
                    "Time": "0001-01-01T00:00:00Z"
                },
                "ShowAs": "Busy",
                "IsAllDay": false,
                "IsCancelled": false,
                "IsOrganizer": true,
                "ResponseRequested": true,
                "Type": "SingleInstance",
                "SeriesMasterId": null,
                "Attendees": [
                ],
                "Recurrence": null,
                "Organizer": {
                    "EmailAddress": {
                        "Address": "user0@contoso.com",
                        "Name": "user0"
                    }
                },
                "iCalUId": "040000008200E9888E07599CCFA23",
                "WebLink": "https://outlook.office.com/owa/?ItemID=AAAINJAAAAA%3D%3D&exvsurl=1&viewmodel=ICalendarItemDetailsViewModelFactory"
            }
        ],
        "@odata.deltaLink": "https://outlook.office.com/api/v1.0/me/calendarview/?startdatetime=2015-01-01T00%3a00%3a00Z&enddatetime=2015-04-10T00%3a00%3a00Z&%24deltatoken=v2%2cH4roCAAA%3d%2c1.0%2cFalse%2cA00%2c"
    }

Exemple de deuxième demande

    GET https://outlook.office.com/api/v1.0/me/calendarview?startdatetime=2015-01-01T00:00:00Z&enddatetime=2015-04-10T00:00:00Z&$deltatoken=v2%2cH4roCAAA%3d%2c1.0%2cFalse%2cA00%2c
    Authorization: Bearer <token>
    Prefer: odata.track-changes
    Prefer: odata.maxpagesize=1

Exemple de données d’une deuxième réponse

{
    "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/CalendarView/$delta",
    "value": [
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('user0@contoso.com')/Events('AAMkAD0jAAA=')",
            "@odata.etag": "W/\"P2fd7QAAAAAVFA==\"",
            "Id": "AAMkADNkNmVlOTITVAAAAAA0jAAA=",
            "ChangeKey": "P2fdmIU1QAAAAAVFA==",
            "Categories": [
            ],
            "DateTimeCreated": "2015-04-15T18:59:11.0226221Z",
            "DateTimeLastModified": "2015-04-15T18:59:11.0694979Z",
            "Subject": "1 hour",
            "BodyPreview": "\u200b",
            "Body": {
                "ContentType": "HTML",
                "Content": "<html><body>content</body></html>"
            },
            "Importance": "Normal",
            "HasAttachments": false,
            "Start": "2015-04-16T18:00:00Z",
            "StartTimeZone": "Pacific Standard Time",
            "End": "2015-04-16T19:00:00Z",
            "EndTimeZone": "Pacific Standard Time",
            "Reminder": 15,
            "Location": {
                "DisplayName": "",
                "Address": {
                    "Street": "",
                    "City": "",
                    "State": "",
                    "CountryOrRegion": "",
                    "PostalCode": ""
                }
            },
            "ResponseStatus": {
                "Response": "Organizer",
                "Time": "0001-01-01T00:00:00Z"
            },
            "ShowAs": "Busy",
            "IsAllDay": false,
            "IsCancelled": false,
            "IsOrganizer": true,
            "ResponseRequested": true,
            "Type": "SingleInstance",
            "SeriesMasterId": null,
            "Attendees": [
            ],
            "Recurrence": null,
            "Organizer": {
                "EmailAddress": {
                    "Address": "user0@contoso.com",
                    "Name": "user0"
                }
            },
            "iCalUId": "040000008200E09BB89A316862",
            "WebLink": "https://outlook.office.com/owa/?ItemID=AAMkADNkNmVlOAA%3D&exvsurl=1&viewmodel=ICalendarItemDetailsViewModelFactory"
        }
    ],
    "@odata.nextLink": "https://outlook.office.com/api/v1.0/me/calendarview/?startdatetime=2015-01-01T00%3a00%3a00Z&enddatetime=2015-08-10T00%3a00%3a00Z&%24skipToken=530c9d02ae1a4d96804538bd4d381546"
}

Rechercher les heures de réunion

Cette fonctionnalité est actuellement disponible dans les versions v2.0 et beta.

Obtenir les salles de réunion (aperçu)

Cette fonctionnalité est actuellement disponible uniquement dans la version beta.

Créer des événements

Créer un événement de calendrier

Créer un événement de calendrier

Étendue minimale requise

Un des éléments suivants :

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

Créer un événement dans le calendrier principal de l'utilisateur ou un calendrier spécifique en le publiant dans le point de terminaison events du calendrier. Lorsque l’événement est créé, le serveur envoie des invitations à tous les participants.

Par défaut, les valeurs des heures de Début et de Fin sont au format UTC. Vous pouvez spécifier des fuseaux horaires pour le temps de Début et de Fin, et exprimer l'heure dans le fuseau horaire correspondant, puis inclure un décalage temporel par rapport à l'heure UTC.

L'exemple ci-dessous montre comment définir les valeurs de date/heure dans le fuseau horaire du Pacifique. Remarque : si vous spécifiez un fuseau horaire, vous devez également spécifier une valeur pour les autres aussi.

POST https://outlook.office.com/api/v1.0/me/events
POST https://outlook.office.com/api/v1.0/me/calendars/{calendar_id}/events

Paramètre requis	Type	Description
Paramètres d'URL
calendar_id	chaîne	L'ID du calendrier.

Exemple de demande

POST https://outlook.office.com/api/v1.0/me/events

Content-Type: application/json

{
  "Subject": "Discuss the Calendar REST API",
  "Body": {
    "ContentType": "HTML",
    "Content": "I think it will meet our requirements!"
  },
  "Start": "2014-02-02T18:00:00-08:00",
  "StartTimeZone": "Pacific Standard Time",
  "End": "2014-02-02T19:00:00-08:00",
  "EndTimeZone": "Pacific Standard Time",
  "Attendees": [
    {
      "EmailAddress": {
        "Address": "janets@a830edad9050849NDA1.onmicrosoft.com",
        "Name": "Janet Schorr"
      },
      "Type": "Required"
    }
  ]
}

Exemple de réponse

Code d’état : 201

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Events/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "@odata.etag": "W/\"Jj9S59cHB0Wq4jXUzBgDvQAAFeNheA==\"",
  "Id": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MABGAAAAAAC_0WfqSjt_SqLtNkuO-bj1BwAmP1Ln1wcHRariNdTMGAO9AAAAAAENAAAmP1Ln1wcHRariNdTMGAO9AAAV4v1RAAA=",
  "ChangeKey": "Jj9S59cHB0Wq4jXUzBgDvQAAFeNheA==",
  "Categories": [],
  "DateTimeCreated": "2014-01-22T20:56:10.1058291Z",
  "DateTimeLastModified": "2014-01-22T20:56:10.3402186Z",
  "Subject": "Discuss the Calendar REST API",
  "BodyPreview": "I think it will meet our requirements!",
  "Body": {
    "ContentType": "HTML",
    "Content": "<html>\r\n<head>\r\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\r\n</head>\r\n<body>\r\nI think it will meet our requirements!\r\n</body>\r\n</html>\r\n"
  },
  "Importance": "Normal",
  "HasAttachments": false,
  "Start": "2014-02-02T18:00:00-08:00",
  "StartTimeZone": "Pacific Standard Time",
  "End": "2014-02-02T19:00:00-08:00",
  "EndTimeZone": "Pacific Standard Time",
  "Location": {
    "DisplayName": ""
  },
  "ShowAs": "Busy",
  "IsAllDay": false,
  "IsCancelled": false,
  "IsOrganizer": true,
  "ResponseRequested": true,
  "Type": "SingleInstance",
  "SeriesMasterId": null,
  "Attendees": [
    {
      "EmailAddress": {
        "Address": "janets@a830edad9050849NDA1.onmicrosoft.com",
        "Name": "Janet Schorr"
      },
      "Status": {
        "Response": "None",
        "Time": "0001-01-01T00:00:00Z"
      },
      "Type": "Required"
    }
  ],
  "Recurrence": null,
  "Organizer": {
    "EmailAddress": {
      "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com",
      "Name": "alexd"
    }
  }
}

Type de réponse

Le nouvel événement.

Par défaut, la réponse inclut toutes les propriétés du nouvel événement. Utilisez $select pour spécifier uniquement les propriétés dont vous avez besoin pour optimiser les performances. La propriété Id est toujours renvoyée.

L'exemple suivant montre comment inclure uniquement les propriétés Début et Fin du nouvel événement dans la réponse.

POST https://outlook.office.com/api/v1.0/me/events?$Select=Start,End

Mise à jour d’événements

Mettre à jour un événement de calendrier

Mettre à jour un événement de calendrier

Étendue minimale requise

Un des éléments suivants :

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

Modifier un événement. Seules les propriétés que vous spécifiez sont modifiées. Si l’utilisateur est l’organisateur, le serveur envoie les mises à jour de réunion à tous les participants.

PATCH https://outlook.office.com/api/v1.0/me/events/{event_id}

Paramètre requis	Type	Description
Paramètres d'URL
event_id	chaîne	L’ID d’événement.

Spécifiez toutes les propriétés d’événement accessibles en écriture dans le corps de la demande.

Exemple de demande

PATCH https://outlook.office.com/api/v1.0/me/events/AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MABGAAAAAAC_0WfqSjt_SqLtNkuO-bj1BwAmP1Ln1wcHRariNdTMGAO9AAAAAAENAAAmP1Ln1wcHRariNdTMGAO9AAAV4v1OAAA=

Content-Type: application/json

{
  "Location": {
    "DisplayName": "Your office"
  }
}

Exemple de réponse

Code d’état : 200

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Events/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "@odata.etag": "W/\"Jj9S59cHB0Wq4jXUzBgDvQAAFeNheQ==\"",
  "Id": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MABGAAAAAAC_0WfqSjt_SqLtNkuO-bj1BwAmP1Ln1wcHRariNdTMGAO9AAAAAAENAAAmP1Ln1wcHRariNdTMGAO9AAAV4v1OAAA=",
  "ChangeKey": "Jj9S59cHB0Wq4jXUzBgDvQAAFeNheQ==",
  "Categories": [],
  "DateTimeCreated": "2014-01-22T20:49:05.5657528Z",
  "DateTimeLastModified": "2014-01-22T21:14:17.4886416Z",
  "Subject": "Discuss the Calendar REST API",
  "BodyPreview": "I think it will meet our requirements!",
  "Body": {
    "ContentType": "HTML",
    "Content": "<html>\r\n<head>\r\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\r\n</head>\r\n<body>\r\nI think it will meet our requirements!\r\n</body>\r\n</html>\r\n"
  },
  "Importance": "Normal",
  "HasAttachments": false,
  "Start": "2014-02-02T18:00:00-08:00",
  "StartTimeZone": "Pacific Standard Time",
  "End": "2014-02-02T19:00:00-08:00",
  "EndTimeZone": "Pacific Standard Time",
  "Location": {
    "DisplayName": "Your office"
  },
  "ShowAs": "Busy",
  "IsAllDay": false,
  "IsCancelled": false,
  "IsOrganizer": true,
  "ResponseRequested": true,
  "Type": "SingleInstance",
  "SeriesMasterId": null,
  "Attendees": [],
  "Recurrence": null,
  "Organizer": {
    "EmailAddress": {
      "Address": "alexd@a830edad9050849NDA1.onmicrosoft.com",
      "Name": "alexd"
    }
  }
}

Type de réponse

L'événement mis à jour. Si l’utilisateur est l’organisateur, le serveur envoie les mises à jour de réunion à tous les participants.

Par défaut, la réponse inclut toutes les propriétés de l’événement mis à jour. Utilisez $select pour spécifier uniquement les propriétés dont vous avez besoin pour optimiser les performances. La propriété Id est toujours renvoyée.

PATCH https://outlook.office.com/api/v1.0/me/events/AAMkAGE1MFKPQWAAA=?$select=Location

Accepter l'événement

Étendue minimale requise

Un des éléments suivants :

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

Accepte l’événement spécifié.

POST https://outlook.office.com/api/v1.0/me/events/{event_id}/accept

Paramètre	Type	Description
Paramètres d'URL
event_id	chaîne	L’ID d’événement. Obligatoire.
Paramètres de corps
Commentaire	chaîne	Texte inclus dans la réponse. Facultatif.
SendResponse	booléen	`true` si une réponse est envoyée à l’organisateur ; dans le cas contraire, `false`. Facultatif. La valeur par défaut est `true`.

Exemple de demande

POST https://outlook.office.com/api/v1.0/me/events('AAMkAGE1M2IyNGNmLTI5MT_bs88AAAXDJwEAAA=')/accept

Content-Type: application/json

{
  "Comment": "Great idea!",
  "SendResponse": "true"
}

Réponse

Une réponse réussie est indiquée par un code de réponse HTTP 202 Accepted.

Accepter provisoirement l'événement

Étendue minimale requise

Un des éléments suivants :

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

Accepte provisoirement l’événement spécifié.

POST https://outlook.office.com/api/v1.0/me/events/{event_id}/tentativelyaccept

Paramètre	Type	Description
Paramètres d'URL
event_id	chaîne	L’ID d’événement. Obligatoire.
Paramètres de corps
Commentaire	chaîne	Texte inclus dans la réponse. Facultatif.
SendResponse	booléen	`true` si une réponse est envoyée à l’organisateur ; dans le cas contraire, `false`. Facultatif. La valeur par défaut est `true`.

Exemple de demande

POST https://outlook.office.com/api/v1.0/me/events('AAMkAGE1M2IyNGNmLTI5MT_bs88AAAXDJwEAAA=')/tentativelyaccept

Content-Type: application/json

{
  "Comment": "I'll confirm later!",
  "SendResponse": "true"
}

Réponse

Une réponse réussie est indiquée par un code de réponse HTTP 202 Accepted.

Décliner un événement

Étendue minimale requise

Un des éléments suivants :

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

Refuser l’invitation à l’événement spécifié.

POST https://outlook.office.com/api/v1.0/me/events/{event_id}/decline

Paramètre	Type	Description
Paramètres d'URL
event_id	chaîne	L’ID d’événement. Obligatoire.
Paramètres de corps
Commentaire	chaîne	Texte inclus dans la réponse. Facultatif.
SendResponse	booléen	`true` si une réponse est envoyée à l’organisateur ; dans le cas contraire, `false`. Facultatif. La valeur par défaut est `true`.

Exemple de demande

POST https://outlook.office.com/api/v1.0/me/events('AAMkAGE1M2IyNGNmLTI5MT_bs88AAAXDJwEAAA=')/decline

Content-Type: application/json

{
  "Comment": "Sorry, maybe next time!",
  "SendResponse": "true"
}

Réponse

Une réponse réussie est indiquée par un code de réponse HTTP 202 Accepted.

Transférer les événements (aperçu)

Cette fonctionnalité est actuellement disponible uniquement dans la version beta.

Supprimer des événements

Supprimer un événement de calendrier

Supprimer un événement de calendrier

Étendue minimale requise

Un des éléments suivants :

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

Déplacer un événement dans le dossier Éléments supprimés de l’utilisateur connecté. Si l’événement est une réunion et que l’utilisateur connecté en est l'organisateur, le serveur envoie les annulations à tous les participants.

DELETE https://outlook.office.com/api/v1.0/me/events/{event_id}

Paramètre requis	Type	Description
Paramètres d'URL
event_id	chaîne	L’ID d’événement.

Exemple de demande

DELETE https://outlook.office.com/api/v1.0/me/events/AAMkAGE0M4v1OAAA=

Exemple de réponse

Status code: 204

Annuler les événements (aperçu)

Cette fonctionnalité est actuellement disponible uniquement dans la version beta.

Obtenir les pièces jointes

Vous pouvez obtenir une collection de pièces jointes ou une pièce jointe.

Obtenir une collection de pièces jointes
Obtenir une pièce jointe

Obtenir une collection de pièces jointes

Étendue minimale requise

Un des éléments suivants :

https://outlook.office.com/calendars.read
wl.calendars
wl.contacts_calendars

Obtenir les pièces jointes à partir d'un événement spécifique.

Notes

Voir Paramètres de requête OData pour les paramètres de filtrage, de tri et de pagination.

GET https://outlook.office.com/api/v1.0/me/events/{event_id}/attachments

Paramètre requis	Type	Description
Paramètres d'URL
event_id	chaîne	L’ID d’événement.

Type de réponse

Une collection de pièces jointes pouvant être du type FileAttachment ou ItemAttachment.

Exemple de demande

GET https://outlook.office.com/api/v1.0/me/events/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG9yAAA=/attachments

Exemple de réponse

Code d’état : 200

{
    "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Events('AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG9yAAA%3D')/Attachments",
    "value": [
        {
            "@odata.type": "#Microsoft.OutlookServices.FileAttachment",
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2NGTG9yAAA=')/Attachments('AAMkAGI2NGLwydGuOzcHf1FBlo=')",
            "Id": "AAMkAGI2NGLwydGuOzcHf1FBlo=",
            "DateTimeLastModified": "2014-10-22T00:30:26Z",
            "Name": "Company Party.docx",
            "ContentType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
            "Size": 11647,
            "IsInline": false,
            "ContentId": null,
            "ContentLocation": null,
            "ContentBytes": "UEsDBBQABgAIAAAAIQDfpNJs...AAF4pAAAAAA=="
            "IsContactPhoto": false
        }
    ]
}

Obtenir une pièce jointe

Étendue minimale requise

Un des éléments suivants :

https://outlook.office.com/calendars.read
wl.calendars
wl.contacts_calendars

Obtenir une pièce jointe à partir d'un événement particulier.

GET https://outlook.office.com/api/v1.0/me/events/{event_id}/attachments/{attachment_id}

Paramètre requis	Type	Description
Paramètres d'URL
event_id	chaîne	L’ID d’événement.
attachment_id	chaîne	ID de la pièce jointe.

Notes

Voir Paramètres de requête OData pour les paramètres de filtrage, de tri et de pagination.

Type de réponse

Le fichier joint ou l’élément joint demandés.

Exemple de demande

GET https://outlook.office.com/api/v1.0/me/events/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG9yAAA=/attachments/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG9yAAABEgAQALxJtn1LwydGuOzcHf1FBlo=

Exemple de réponse

Code d’état : 200

{
    "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Events('AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAENAACd9nJ-tVysQos2hTfspaWRAAADTG9yAAA%3D')/Attachments/$entity",
    "@odata.type": "#Microsoft.OutlookServices.FileAttachment",
    "@odata.id": "https://outlook.office.com/api/v2.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2WRAAADTG9yAAA=')/Attachments('AAMkAGI2TG9yAAABEgAQALxJtn1LwydGuOzcHf1FBlo=')",
    "Id": "AAMkAGI2TG9yAAABEgAQALxJtn1LwydGuOzcHf1FBlo="
    "DateTimeLastModified": "2014-10-22T00:30:26Z",
    "Name": "Company Party.docx",
    "ContentType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
    "Size": 11647,
    "IsInline": false,
    "ContentId": null,
    "ContentLocation": null,
    "ContentBytes": "UEsDBBQABgAIAAAAIQD...AAF4pAAAAAA==",
    "IsContactPhoto": false
}

Créer des pièces jointes

Vous pouvez créer un fichier joint ou créer un élément joint pour un événement.

Créer un fichier joint
Créer un élément joint
Créer une référence jointe

Créer un fichier joint

Étendue minimale requise

Un des éléments suivants :

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

Ajouter un fichier joint à un événement.

POST https://outlook.office.com/api/v1.0/me/events/{event_id}/attachments

Paramètre requis	Type	Description
Paramètres d'URL
event_id	chaîne	L’ID d’événement.
Paramètres de corps
@odata.type	chaîne	#Microsoft.OutlookServices.FileAttachment
Nom	chaîne	Nom de la pièce jointe.
ContentBytes	binaire	Le fichier à joindre.

Type de réponse

Le nouveau fichier joint.

Créer un élément joint

Étendue minimale requise

Un des éléments suivants :

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

Ajouter un élément joint à un événement.

POST https://outlook.office.com/api/v1.0/me/events/{event_id}/attachments

Paramètre requis	Type	Description
Paramètres d'URL
event_id	chaîne	L’ID d’événement.
Paramètres de corps
@odata.type	chaîne	#Microsoft.OutlookServices.ItemAttachment
Nom	chaîne	Nom de la pièce jointe.
Élément	Une entité Message, Événement, ou Contact.	L’élément à joindre.

Type de réponse

Le nouvel élément joint.

Créer une référence jointe

Étendue minimale requise

https://outlook.office.com/calendars.readwrite

Ajouter une référence jointe à un événement.

Cette fonctionnalité est actuellement disponible uniquement dans la version beta.

Supprimer les pièces jointes

Supprimer la pièce jointe d’un événement

Supprimer la pièce jointe d’un événement

Étendue minimale requise

Un des éléments suivants :

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

Supprimer la pièce jointe spécifiée d’un événement. La pièce jointe peut être un fichier joint ou un élément joint.

DELETE https://outlook.office.com/api/v1.0/me/events/{event_id}/attachments/{attachment_id}

Paramètre requis	Type	Description
Paramètres d'URL
event_id	chaîne	L’ID d’événement.
attachment_id	chaîne	ID de la pièce jointe.

Exemple de demande

DELETE https:/outlook.office.com/api/v1.0/me/events/AAMkAGE0MG4v1OAAA=/attachments/AAMkAGITG9yAAA=

Exemple de réponse

Status code: 204

Obtenir les rappels

Obtenez une liste de rappels d'événements entre deux dates et heures à partir du calendrier.

Étendue minimale requise

Un des éléments suivants :

https://outlook.office.com/calendars.read
wl.calendars
wl.contacts_calendars

Cette fonctionnalité est actuellement disponible dans les versions v2.0 et beta.

Répéter les rappels

Répéter le rappel à une heure ultérieure.

Étendue minimale requise

Un des éléments suivants :

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

Cette fonctionnalité est actuellement disponible dans les versions v2.0 et beta.

Ignorer les rappels

Masquer un rappel qui a été activé.

Étendue minimale requise

Un des éléments suivants :

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

Cette fonctionnalité est actuellement disponible dans les versions v2.0 et beta.

Obtenir les calendriers

Vous pouvez obtenir une collection de calendriers ou obtenir un calendrier.

Obtenir une collection de calendriers
Obtenir un calendrier

Obtenir une collection de calendriers

Étendue minimale requise

Un des éléments suivants :

https://outlook.office.com/calendars.read
wl.calendars
wl.contacts_calendars

Obtenir tous les calendriers de l’utilisateur (calendars) ou obtenir les calendriers d’un groupe de calendriers spécifiques.

GET https://outlook.office.com/api/v1.0/me/calendars
GET https://outlook.office.com/api/v1.0/me/calendargroups/{calendar_group_id}/calendars

Notes

Voir Paramètres de requête OData pour les paramètres de filtrage, de tri et de pagination.

Paramètre requis	Type	Description
Paramètres d'URL
calender_group_id	chaîne	L’ID du groupe de calendriers.

Exemple de demande

GET https://outlook.office.com/api/v1.0/me/calendars

Exemple de réponse

Code d’état : 200

{
    "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Calendars",
    "value": [
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEGAACd9nJ-tVysQos2hTfspaWRAAADTGuLAAA=",
            "Name": "Calendar",
            "Color": "Auto",
            "ChangeKey": "nfZyf7VcrEKLNoU37KWlkQAAA0x0+w=="
        }
    ]
}

Type de réponse

La collection de calendriers demandée.

Obtenir un calendrier

Étendue minimale requise

Un des éléments suivants :

https://outlook.office.com/calendars.read
wl.calendars
wl.contacts_calendars

Obtenir un calendrier par ID. Vous pouvez obtenir le calendrier principal de l’utilisateur à l’aide du point de terminaison ../me/calendar.

GET https://outlook.office.com/api/v1.0/me/calendars/{calendar_id}

Notes

Voir Paramètres de requête OData pour les paramètres de filtrage, de tri et de pagination.

Paramètre requis	Type	Description
Paramètres d'URL
calendar_id	chaîne	L'ID du calendrier.

Exemple de demande

GET https://outlook.office.com/api/v1.0/me/calendars/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEGAACd9nJ-tVysQos2hTfspaWRAAADTGuLAAA=

Exemple de réponse

Code d’état : 200

{
    "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Calendars/$entity",
    "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
    "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEGAACd9nJ-tVysQos2hTfspaWRAAADTGuLAAA=",
    "Name": "Calendar",
    "Color": "Auto",
    "ChangeKey": "nfZyf7VcrEKLNoU37KWlkQAAA0x0+w=="
}

Type de réponse

Le calendrier demandé.

Créer des agendas

Créer un calendrier

Créer un calendrier

Étendue minimale requise

Un des éléments suivants :

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

Créez un calendrier dans le groupe de calendriers par défaut en utilisant le raccourci ../me/calendars, ou dans un groupe de calendriers particulier en le publiant dans le point de terminaison calendars du groupe.

POST https://outlook.office.com/api/v1.0/me/calendars
POST https://outlook.office.com/api/v1.0/me/calendargroups/{calendar_group_id}/calendars

Paramètre requis	Type	Description
Paramètres d'URL
calender_group_id	chaîne	L’ID du groupe de calendriers, si vous obtenez les calendriers d'un groupe spécifique.
Paramètres de corps
Nom	chaîne	Le nom du nouveau calendrier.

Exemple de demande

POST https://outlook.office.com/api/v1.0/me/calendars

Content-Type: application/json

{
  "Name": "Social"
}

Exemple de réponse

Code d’état : 201

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Calendars/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "@odata.etag": "W/\"Jj9S59cHB0Wq4jXUzBgDvQAAFeN/SQ==\"",
  "Id": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MABGAAAAAAC_0WfqSjt_SqLtNkuO-bj1BwAmP1Ln1wcHRariNdTMGAO9AAAAAAEGAAAmP1Ln1wcHRariNdTMGAO9AAAV4xLHAAA=",
  "Name": "Social",
  "ChangeKey": "Jj9S59cHB0Wq4jXUzBgDvQAAFeN/SQ=="
}

Type de réponse

Le nouveau calendrier.

Mettre à jour les calendriers

Mettre à jour un calendrier

Mettre à jour un calendrier

Étendue minimale requise

Un des éléments suivants :

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

Modifier les propriétés accessibles en écriture d’un calendrier.

PATCH https://outlook.office.com/api/v1.0/me/calendars/{calendar_id}

Paramètre requis	Type	Description
Paramètres d'URL
calendar_id	chaîne	L'ID du calendrier.
Paramètres de corps
Nom	chaîne	Le nouveau nom du calendrier.

Exemple de demande

PATCH https://outlook.office.com/api/v1.0/me/calendars/AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MABGAAAAAAC_0WfqSjt_SqLtNkuO-bj1BwAmP1Ln1wcHRariNdTMGAO9AAAAAAEGAAAmP1Ln1wcHRariNdTMGAO9AAAV4xLIAAA=

Content-Type: application/json

{
  "Name": "Social events"
}

Exemple de réponse

Code d’état : 200

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Calendars/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "@odata.etag": "W/\"Jj9S59cHB0Wq4jXUzBgDvQAAFeN/Sw==\"",
  "Id": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MABGAAAAAAC_0WfqSjt_SqLtNkuO-bj1BwAmP1Ln1wcHRariNdTMGAO9AAAAAAEGAAAmP1Ln1wcHRariNdTMGAO9AAAV4xLIAAA=",
  "Name": "Social events",
  "ChangeKey": "Jj9S59cHB0Wq4jXUzBgDvQAAFeN/Sw=="

Type de réponse

Le calendrier mis à jour.

Supprimer des calendriers

Supprimer un calendrier

Supprimer un calendrier

Étendue minimale requise

Un des éléments suivants :

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

DELETE https://outlook.office.com/api/v1.0/me/calendars/{calendar_id}

Paramètre requis	Type	Description
Paramètres d'URL
calendar_id	chaîne	L'ID du calendrier.

Exemple de demande

DELETE https://outlook.office.com/api/v1.0/me/calendars/{calendar_id}

Exemple de réponse

Status code: 204

Obtenir les groupes de calendriers

Vous pouvez obtenir une collection de groupes de calendriers ou obtenir un groupe de calendriers.

Obtenir une collection de groupes de calendriers
Obtenir un groupe de calendriers

Notes

Outlook.com ne prend en charge que le groupe de calendriers par défaut, qui est accessible par le raccourci ../me/calendars.

Obtenir une collection de groupes de calendriers

Étendue minimale requise

Un des éléments suivants :

https://outlook.office.com/calendars.read
wl.calendars
wl.contacts_calendars

Obtenir des groupes de calendriers dans une boîte aux lettres.

GET https://outlook.office.com/api/v1.0/me/calendargroups

Notes

Voir Paramètres de requête OData pour les paramètres de filtrage, de tri et de pagination.

Exemple de demande

GET https://outlook.office.com/api/v1.0/me/calendargroups

Exemple de réponse

Code d’état : 200

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/CalendarGroups",
  "value": [
    {
      "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
      "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAAA0x0+g==\"",
      "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEGAACd9nJ-tVysQos2hTfspaWRAAADTGuKAAA=",
      "Name": "My Calendars",
      "ChangeKey": "nfZyf7VcrEKLNoU37KWlkQAAA0x0+g==",
      "ClassId": "0006f0b7-0000-0000-c000-000000000046"
    },
    {
      "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
      "@odata.etag": "W/\"nfZyf7VcrEKLNoU37KWlkQAAA0x0/A==\"",
      "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEGAACd9nJ-tVysQos2hTfspaWRAAADTGuMAAA=",
      "Name": "Other Calendars",
      "ChangeKey": "nfZyf7VcrEKLNoU37KWlkQAAA0x0/A==",
      "ClassId": "0006f0b8-0000-0000-c000-000000000046"
    }
  ]
}

Type de réponse

La collection de groupes de calendriers demandée.

Obtenir un groupe de calendriers

Étendue minimale requise

Un des éléments suivants :

https://outlook.office.com/calendars.read
wl.calendars
wl.contacts_calendars

Obtenir un groupe de calendriers par ID.

GET https://outlook.office.com/api/v1.0/me/calendargroups/{calendar_group_id}

Notes

Voir Paramètres de requête OData pour les paramètres de filtrage, de tri et de pagination.

Paramètre requis	Type	Description
Paramètres d'URL
calendar_group_id	chaîne	L’ID du groupe de calendriers.

Exemple de demande

GET https://outlook.office.com/api/v1.0/me/calendargroups/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEGAACd9nJ-tVysQos2hTfspaWRAAADTGuKAAA=

Exemple de réponse

{
    "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/CalendarGroups/$entity",
    "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGI2TG9xAAA=')",
    "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEGAACd9nJ-tVysQos2hTfspaWRAAADTGuKAAA=",
    "Name": "My Calendars",
    "ClassId": "0006f0b7-0000-0000-c000-000000000046",
    "ChangeKey": "nfZyf7VcrEKLNoU37KWlkQAAA0x0+g=="
}

Type de réponse

Le groupe de calendriers demandé.

Créer des groupes d’agendas

Créer un groupe de calendriers. Le nom est la seule propriété accessible en écriture pour un groupe de calendriers.

Créer un groupe de calendriers

Notes

Outlook.com ne prend en charge que le groupe de calendriers par défaut, qui est accessible par le raccourci ../me/calendars. Vous ne pouvez pas créer un autre groupe de calendriers dans Outlook.com.

Créer un groupe de calendriers

Étendue minimale requise

Un des éléments suivants :

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

POST https://outlook.office.com/api/v1.0/me/calendargroups

Paramètre requis	Type	Description
Paramètre d'URL
Paramètres de corps
Nom	chaîne	Le nom du groupe de calendriers.

POST https://outlook.office.com/api/v1.0/me/calendargroups

Content-Type: application/json

{
  "Name": "Birthdays"
}

Exemple de réponse

Code d’état : 201

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/CalendarGroups/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "@odata.etag": "W/\"Jj9S59cHB0Wq4jXUzBgDvQAAFeN/Rw==\"",
  "Id": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MABGAAAAAAC_0WfqSjt_SqLtNkuO-bj1BwAmP1Ln1wcHRariNdTMGAO9AAAAAAEGAAAmP1Ln1wcHRariNdTMGAO9AAAV4xLGAAA=",
  "Name": "Birthdays",
  "ChangeKey": "Jj9S59cHB0Wq4jXUzBgDvQAAFeN/Rw==",
  "ClassId": "4d969bba-8942-42a0-ae33-c7d4410d1e11"
}

Type de réponse

Le nouveau groupe de calendriers.

Mettre à jour les groupes de calendriers

Mettre à jour un groupe d’agendas

Mettre à jour un groupe de calendriers

Étendue minimale requise

Un des éléments suivants :

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

Changer le nom d'un groupe de calendriers. Le nom est la seule propriété accessible en écriture du groupe de calendriers.

PATCH https://outlook.office.com/api/v1.0/me/calendargroups/{calendar_group_id}

Paramètre requis	Type	Description
Paramètres d'URL
calendar_group_id	chaîne	L’ID du groupe de calendriers.
Paramètres de corps
Nom	chaîne	Le nom du groupe de calendriers mis à jour.

PATCH https://outlook.office.com/api/v1.0/me/calendargroups/AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MABGAAAAAAC_0WfqSjt_SqLtNkuO-bj1BwAmP1Ln1wcHRariNdTMGAO9AAAAAAEGAAAmP1Ln1wcHRariNdTMGAO9AAAV4xLGAAA=

{
  "Name": "Holidays"
}

Exemple de réponse

Code d’état : 200

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/CalendarGroups/$entity",
  "@odata.id": "https://https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "@odata.etag": "W/\"Jj9S59cHB0Wq4jXUzBgDvQAAFeN/SA==\"",
  "Id": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MABGAAAAAAC_0WfqSjt_SqLtNkuO-bj1BwAmP1Ln1wcHRariNdTMGAO9AAAAAAEGAAAmP1Ln1wcHRariNdTMGAO9AAAV4xLGAAA=",
  "Name": "Holidays",
  "ChangeKey": "Jj9S59cHB0Wq4jXUzBgDvQAAFeN/SA==",
  "ClassId": "4d969bba-8942-42a0-ae33-c7d4410d1e11"
}

Type de réponse

Le groupe de calendriers mis à jour.

Supprimer des groupes de calendriers

Supprimer un groupe de calendriers

Notes

Outlook.com ne prend en charge que le groupe de calendriers par défaut, qui est accessible par le raccourci ../me/calendars. Ne pas supprimer ce groupe de calendriers.

Supprimer un groupe de calendriers

Étendue minimale requise

Un des éléments suivants :

https://outlook.office.com/calendars.readwrite
wl.calendars_update
wl.events_create

DELETE https://outlook.office.com/api/v1.0/me/calendargroups/{calendar_group_id}

Paramètre requis	Type	Description
Paramètres d'URL
calendar_group_id	chaîne	L’ID du groupe de calendriers.

Exemple de demande

DELETE https://outlook.office.com/api/v1.0/me/calendargroups/AAMkAGE0MGM4xLGAAA=

Exemple de réponse

Status code: 204

Étapes suivantes

Que vous soyez prêt à commencer à créer une application ou que vous souhaitiez simplement en apprendre plus, nous avons ce qu’il vous faut.

Premiers pas avec les API REST Courrier, Calendrier et Contacts.
Voulez-vous des exemples ? Nous en avons.

Ou, pour en savoir plus sur l’utilisation de la plateforme Office 365 :

Partager via

Référence de l'API REST Calendrier pour Outlook (version 1.0)

Toutes les opérations de l’API Calendrier

Opérations d'événement

Opérations de calendrier

Opérations du groupe de calendriers

Voir aussi

Utilisation de l’API REST Calendrier

Authentification

Étendues pour accéder aux calendriers partagés

Version de l’API

Utilisateur cible

Obtenir les événements

Obtenir une vue du calendrier

Étendue minimale requise

Type de réponse

Obtenir les événements maître et les événements simples

Étendue minimale requise

Exemple de demande

Exemple de réponse

Obtenir les instances de l’événement

Étendue minimale requise

Type de réponse

Obtenir un événement

Étendue minimale requise

Exemple de demande

Exemple de réponse

Type de réponse

Exemple de demande

Exemple de réponse

Synchroniser les événements

Étendue minimale requise

En-têtes de demande

Pour synchroniser dans le calendrier par défaut

Pour synchroniser dans un calendrier spécifique

Paramètres

Type de réponse

Exemple

Rechercher les heures de réunion

Obtenir les salles de réunion (aperçu)

Créer des événements

Créer un événement de calendrier

Étendue minimale requise

Exemple de demande

Exemple de réponse

Type de réponse

Mise à jour d’événements

Mettre à jour un événement de calendrier

Étendue minimale requise

Exemple de demande

Exemple de réponse

Type de réponse

Répondre aux événements

Accepter l'événement

Étendue minimale requise

Exemple de demande

Réponse

Accepter provisoirement l'événement

Étendue minimale requise

Exemple de demande

Réponse

Décliner un événement

Étendue minimale requise

Exemple de demande

Réponse

Transférer les événements (aperçu)

Supprimer des événements

Supprimer un événement de calendrier

Étendue minimale requise

Exemple de demande

Exemple de réponse

Annuler les événements (aperçu)

Obtenir les pièces jointes

Obtenir une collection de pièces jointes

Étendue minimale requise

Type de réponse

Exemple de demande

Exemple de réponse

Obtenir une pièce jointe

Étendue minimale requise