Utilisation de calendriers et d’événements à l’aide de Microsoft API Graph

L’API Calendrier Microsoft Graph fournit calendrier, calendarGroup, événement et d’autres ressources qui vous permettent de créer des événements et des réunions, de trouver des heures de réunion exploitables, de gérer les participants, etc. Avec l’API Calendrier, vous pouvez créer diverses expériences avec les données de calendrier.

Gérer les événements et les réunions

Le type d’événement représente une occurrence planifiée dans un calendrier, telle qu’une réunion, un congé ou un bloc de temps. Les réunions, telles que les réunions d’équipe ou les réunions individuelles, sont toutes représentées par des ressources d’événement . Vous pouvez gérer directement le cycle de vie des événements en créant, en annulant et en supprimant directement des événements, entre autres actions. En outre, vous pouvez créer des brouillons de messages d’événement, les envoyer, les transférer et créer des brouillons de réponses, etc. En travaillant avec les messages d’événement, vous permettez à l’utilisateur de jouer un rôle actif dans la création d’événements et de réunions. Vous leur permettez également de communiquer avec les organisateurs de la réunion, les autres destinataires et les participants.

Utilisation directe des événements

Microsoft API Graph fournit des méthodes pour les opérations telles que la création, la mise à jour, la suppression et l’annulation d’événements. Le tableau suivant répertorie certains cas d’utilisation courants des événements de cycle de vie et les API que Microsoft Graph fournit pour les utiliser.

Cas d’utilisation	Verbe	Exemple d'URL
Créez un événement.	POST	/users/{id | userPrincipalName}/events
Supprimer un événement d’un calendrier.	SUPPRIMER	/users/{id | userPrincipalName}/events/{id}
Annuler un événement et envoyer un message d’annulation. Remarque : spécifiez le message d’annulation facultatif dans le corps de la demande.	POST	/users/{id | userPrincipalName}/events/{id}/cancel
Mettre à jour un événement. Remarque : spécifiez les détails de l’événement à mettre à jour dans le corps de la demande.	PATCH	/users/{id | userPrincipalName}/events/{id}
Accepter un événement.	POST	/users/{id | userPrincipalName}/events/{id}/accept
Accepter provisoirement un événement.	POST	/users/{id | userPrincipalName}/events/{id}/provisoirelyAccept
Refuser un événement.	POST	/users/{id | userPrincipalName}/events/{id}/decline
Ignorer un rappel d’événement.	POST	/users/{id | userPrincipalName}/events/{id}/dismissReminder
Répéter un rappel d’événement.	POST	/users/{id | userPrincipalName}/events/{id}/snoozeReminder

Utilisation des messages d’événement

La ressource eventMessage est un type abstrait qui représente les demandes de réunion, les annulations et les réponses. Les réponses sont générées lorsque le destinataire du message accepte, accepte provisoirement ou refuse la demande. La gestion des événements EventMessageRequest et eventMessageResponse déplace l’événement tout au long de son cycle de vie. Les API de messagerie dans l’API Calendrier prennent en charge le contenu MIME et JSON.

Le tableau suivant répertorie certains cas d’usage courants des messages d’événement et les API pour les utiliser.

Cas d’utilisation	Verbe	Exemple d'URL
Envoyer un brouillon de message existant.	POST	/users/{id | userPrincipalName}/messages/{id}/send
Créez un brouillon de réponse.	POST	/users/{id | userPrincipalName}/messages/{id}/createReply
Répondre à un message d’événement.	POST	/users/{id | userPrincipalName}/messages/{id}/reply
Créez un brouillon de message reply-all.	POST	/users/{id | userPrincipalName}/messages/{id}/createReplyAll
Répondre à tous dans un message d’événement.	POST	/users/{id | userPrincipalName}/messages/{id}/replyAll
Créez un brouillon.	POST	/users/{id | userPrincipalName}/messages/{id}/createForward
Transférer un message d’événement.	POST	/users/{id | userPrincipalName}/messages/{id}/forward

Ajout et suppression de pièces jointes

Le type de pièce jointe abstraite sert de base pour les fichiers, les éléments et les références attachés à des événements, des messages et des publications. Vous pouvez afficher les pièces jointes d’un événement, par exemple, avec la méthode Lister les pièces jointes . Vous pouvez supprimer une pièce jointe à l’aide de la méthode Delete attachment . Les événements dans les calendriers de groupe ne prennent pas en charge les pièces jointes.

Types de pièces jointes

Les types fileAttachment, itemAttachment et referenceAttatchment représentent les trois types d’éléments qui peuvent être attachés aux éléments de calendrier. Un objet itemAttachment représente un contact, un événement ou un message directement attaché à un événement, un message ou une publication utilisateur. Un élément fileAttachment représente un fichier directement attaché. Un élément referenceAttachment représente un élément, tel qu’un document Word ou un fichier texte, qui se trouve sur un lecteur cloud OneDrive professionnel ou scolaire, ou sur un autre emplacement de stockage pris en charge. Pour voir toutes les pièces jointes d’un événement, par exemple, vous pouvez utiliser le point de terminaison GET /users/{id | userPrincipalName}/events/{id}/attachments .

Chargement de pièces jointes

Vous pouvez charger directement des pièces jointes d’une taille inférieure à 3 Mo dans un événement pour un utilisateur à l’aide de la méthode Ajouter une pièce jointe . Toutefois, pour une pièce jointe supérieure à 3 Mo, vous devez utiliser la méthode attachment : createUploadSession pour obtenir une URL de chargement que vous utilisez pour charger la pièce jointe de manière itérative.

Utiliser des calendriers, des groupes de calendriers et des catégories Outlook

Avec l’API Calendrier, vous pouvez créer, lire, mettre à jour et supprimer des calendriers, créer et afficher des événements de calendrier, obtenir des informations de disponibilité pour les utilisateurs et rechercher des heures de réunion suggérées.

L’API Calendrier fournit des méthodes pour fonctionner sur les calendriers et les groupes de calendriers. Le tableau suivant présente certains cas d’usage avec des URL sélectionnées.

Remarque : La plupart des méthodes présentées dans le tableau suivant ont d’autres URL pour des cas d’usage connexes. Par exemple, pour mettre à jour le calendrier d’un utilisateur dans un groupe de calendriers spécifique, envoyez une opération PATCH avec l’URL /users/{id | userPrincipalName}/calendarGroups/{id}/calendars/{id}.

Cas d’utilisation	Verbe	Exemple d'URL
Répertorier les calendriers d’un utilisateur.	GET	/users/{id | userPrincipalName}/calendars
Répertorier les calendriers d’un utilisateur dans un groupe.	GET	/users/{id | userPrincipalName}/calendarGroups/{calendarGroupId}/calendars
Créez un calendrier.	POST	/users/{id | userPrincipalName}/calendars
Obtenir un calendrier.	GET	/users/{id | userPrincipalName}/calendars/{id}
Mettre à jour un calendrier.	PATCH	/users/{id | userPrincipalName}/calendars/{id}
Supprimer un calendrier.	SUPPRIMER	/users/{id | userPrincipalName}/calendars/{id}
Créez un groupe de calendriers.	POST	/users/{id | userPrincipalName}/calendarGroups
Obtenir un groupe de calendriers.	GET	/users/{id | userPrincipalName}/calendarGroups/{id}
Mettre à jour un groupe de calendriers.	PATCH	/users/{id | userPrincipalName}/calendarGroups/{id}
Supprimer un groupe de calendriers.	SUPPRIMER	/users/{id | userPrincipalName}/calendarGroups/{id}

Données de disponibilité et heures de réunion

Deux des fonctions principales du calendrier sont la recherche d’informations de disponibilité et la recherche d’heures de réunion afin de planifier des réunions. L’API Calendar fournit la méthode Get free/busy schedule qui retourne une collection d’objets scheduleInformation pour une période de temps et une collection d’utilisateurs, de ressources ou de listes de distribution. Vous pouvez présenter ces informations à l’utilisateur afin qu’il puisse choisir manuellement un moment approprié pour planifier une réunion. Utilisez la méthode user : findMeetingTimes pour obtenir un meetingTimeSuggestionResult qui contient une collection d’objets meetingTimeSuggestion qui représentent des informations détaillées sur les heures de réunion proposées pour les participants et les contraintes que vous avez envoyées.

Catégories Outlook

Une catégorie de calendrier est une combinaison d’une description et d’une categoryColor qui définissent ensemble une catégorie pour un élément Outlook et contrôlent la façon dont Outlook affiche l’élément. Les utilisateurs Outlook peuvent regrouper des messages et des événements, par exemple, par catégorie. Pour plus d’informations, consultez outlookCategory.

Autorisations de calendrier

Lorsque les utilisateurs partagent des calendriers avec d’autres utilisateurs à partir de clients Outlook, ils peuvent contrôler les éléments de calendrier que les destinataires peuvent afficher ou modifier. La relation calendarPermissions contient des autorisations pour chaque utilisateur avec lequel un utilisateur a partagé son calendrier. Cette relation vous permet, par exemple, de voir quels utilisateurs peuvent afficher les informations de disponibilité du propriétaire, afficher toutes les informations de calendrier ou modifier les événements du calendrier.

Utiliser des extensions ouvertes et des propriétés étendues

Les extensions ouvertes, anciennement appelées extensions de données Office 365, représentent le moyen préféré de stocker et d’accéder aux données personnalisées pour les ressources dans la boîte aux lettres d’un utilisateur. Si aucune propriété MAPI Outlook n’est disponible dans les métadonnées microsoft API Graph, vous pouvez revenir aux propriétés étendues d’Outlook. Pour plus d’informations, voir Vue d’ensemble des propriétés étendues Outlook.

Étapes suivantes

L’API Calendrier dans Microsoft Graph vous permet de créer une gamme d’expériences avec des données de calendrier. Pour en savoir plus :

• En accédant aux données détaillées des méthodes et des propriétés des ressources les plus utiles pour votre cas.
• Essayez l’API dans l’Afficheur Graph.