Type de ressource « event »
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 .
Événement du calendrier d’un utilisateur ou calendrier par défaut d’un groupe Microsoft 365.
Le nombre maximal de participants inclus dans un événement et le nombre maximal de destinataires dans un eventMessage envoyé à partir d’une boîte aux lettres Exchange Online est de 500. Pour plus d’informations, consultez les limites d’envoi.
Cette ressource prend en charge les fonctions suivantes :
- Ajout de vos propres données aux propriétés personnalisées à l’aide des extensions.
- Abonnementles notifications de modification.
- Utilisation de la requête delta pour effectuer le suivi des suppressions, des mises à jour et des ajouts incrémentiels à l’aide de la fonction delta.
Remarque : il existe quelques différences mineures dans la façon dont vous pouvez interagir avec les calendriers des utilisateurs, groupes de calendriers et leurs événements :
- Vous pouvez organiser uniquement les calendriers d’utilisateur dans un calendarGroup.
- Vous pouvez ajouter des objets en pièce jointe aux événements des seuls calendriers utilisateur, mais non aux événements des calendriers de groupe.
- Outlook accepte automatiquement toutes les demandes de réunion au nom de groupes. Vous pouvez accepter, accepter provisoirement ou refuser les demandes de réunion pour les calendriers utilisateur uniquement.
- Outlook ne prend en charge les rappels pour les événements de groupe. Vous pouvez répéter ou faire disparaître un rappel pour les calendriersutilisateuruniquement.
Méthodes
| Méthode | Type renvoyé | Description |
|---|---|---|
| List | collection Événement | Récupère la liste des objets event présents dans la boîte aux lettres de l’utilisateur. La liste contient les instances uniques de réunions et les masques des séries. |
| Create | event | Crée un événement en publiant dans la collection d’instances. |
| Obtenir | event | Lis les propriétés et les relations de l’objet « event ». |
| Mettre à jour | event | Met à jour l’objet « event ». |
| Supprimer | Aucun | Supprimer un objet « event ». |
| Supprimer définitivement | Aucune | Supprimez définitivement un événement et placez-le dans le dossier Purges du dossier Éléments récupérables de la boîte aux lettres de l’utilisateur. |
| Obtenir delta | collection event | Obtenez un ensemble d’événements qui ont été ajoutés, supprimés ou mis à jour dans un calendarView (une plage d’événements) du calendrier principal de l’utilisateur. |
| Transférer un événement | Aucun | Permet à l’organisateur ou le participant d’un événement de réunion de transférer la demande de réunion à un destinataire. |
| Annuler un événement | Aucun | Envoyer le message d’annulation à partir de l’organisateur à tous les participants et annuler la réunion spécifiée. |
| Accepter l’événement | Aucun | Accepter l’événement spécifié dans un calendrier de l’utilisateur. |
| Accepter provisoirement | Aucun | Essayer d’accepter l’événement spécifié dans un calendrier utilisateur. |
| Événement de refus | Aucun | Refuser une invitation à l’événement spécifié. |
| Ignorer le rappel | Aucun | Ignore le rappel pour l’événement spécifié. |
| Répéter le rappel | Aucun | Reporte le rappel pour l’événement spécifié dans le calendrier utilisateur jusqu’à nouvel ordre. |
| Répertorier les instances d’événements | collection Événement | Obtient une collection d’objets « event ». |
| Attachments | ||
| Répertorier les pièces jointes | collectionAttachment | Obtient toutes les pièces jointes d’un événement. |
| Add attachment | Pièce jointe | Ajoute une nouvelle pièce jointe à un événement en publiant dans la collection d’objets pièces jointes . |
| Extensions d’ouverture | ||
| Créer une extension d’ouverture | openTypeExtension | Créer une extension d’ouverture et ajouter des propriétés personnalisées dans une ressource nouvelle ou existante. |
| Obtenir une extension d’ouverture | collection openTypeExtension | Obtenir une extension d’ouverture identifiée par le nom de l’extension. |
| Propriétés étendues | ||
| Créer une propriété à valeur unique | event | Crée une ou plusieurs propriétés étendues à valeur unique dans un événement nouveau ou existant. |
| Obtenir une propriété à valeur unique | event | Obtient des événements contenant une propriété étendue à valeur unique à l’aide de $expand ou $filter. |
| Créer une propriété à valeurs multiples | event | Crée une ou plusieurs propriétés étendues à valeurs multiples dans un événement nouveau ou existant. |
| Obtenir une propriété à valeurs multiples | event | Obtient un événement contenant une propriété étendue à valeurs multiples à l’aide de $expand. |
Propriétés
| Propriété | Type | Description |
|---|---|---|
| allowNewTimeProposals | Booléen |
true si l’organisateur de la réunion autorise les invités à proposer une nouvelle heure lors de la réponse ; sinon false, . Facultatif. La valeur par défaut est true. |
| attendees | collection participant | Collection des participants à l’événement. |
| body | ItemBody | Corps du message associé à l’événement. Il peut avoir le format HTML ou texte. |
| bodyPreview | String | Aperçu du message associé à l’événement. Il a le format texte. |
| cancelledOccurrences | String collection | Contient les valeurs de propriété occurrenceId des instances annulées dans une série périodique, si l’événement est le maître de série. Les instances d’une série périodique qui sont annulées sont appelées cancelledOccurences. Renvoyé uniquement sur $select dans une opération Get qui spécifie l’ID d’un événement sur le principal de série (autrement dit, la valeur de propriété seriesMasterId). |
| categories | String collection | Catégories associées à l’événement. Chaque catégorie correspond à la propriétédisplayNamed’unoutlookCategorydéfini pour l’utilisateur. |
| changeKey | Chaîne | Identifie la version de l’objet « event ». Chaque fois que l’événement est modifié, la propriété ChangeKey change également. Exchange peut ainsi appliquer les modifications à la version correcte de l’objet. |
| createdDateTime | DateTimeOffset | Le type d’horodatage représente les informations de date et d’heure au moyen du format ISO 8601. Il est toujours au format d’heure UTC. Par exemple, le 1er janvier 2014 à minuit UTC se présente comme suit : 2014-01-01T00:00:00Z. |
| end | DateTimeTimeZone | Date, heure et fuseau horaire de fin de l’événement. Par défaut, l’heure de fin est au format UTC. |
| exceptionOccurrences | collection event | Contient l’id des valeurs de propriété des instances d’événement qui sont des exceptions dans une série périodique. Les exceptions peuvent différer des autres occurrences d’une série périodique, telles que l’objet, l’heure de début ou de fin ou les participants. Les exceptions n’incluent pas les occurrences annulées. Retourné uniquement sur $select et $expand dans une opération GET qui spécifie l’ID d’un événement maître de série (autrement dit, la valeur de la propriété seriesMasterId ). |
| hasAttachments | Boolean | Valeur True si l’événement a des pièces jointes. |
| hideAttendees | Booléen | Lorsque la valeur trueest attribuée, chaque participant ne voit qu’un seul dans la liste de la demande de réunion et du Suivi de la réunion. La valeur par défaut est False. |
| iCalUId | String | Un identificateur unique pour un événement sur plusieurs calendriers. Cet ID est différent pour chaque occurrence dans une série périodique. En lecture seule. |
| id | Chaîne | Identificateur unique de l’événement.
Par défaut, cette valeur change lorsque l’élément est déplacé d’un conteneur (tel qu’un dossier ou un calendrier) vers un autre. Pour modifier ce comportement, utilisez l’en-tête Prefer: IdType="ImmutableId". Pour plus d’informations, consultez Obtenir des identificateurs immuables pour les ressources Outlook . Sensible à la cas et en lecture seule. |
| importance | String | Importance de l’événement. Les valeurs possibles sont low, normal et high. |
| isAllDay | Boolean | Valeur True si l’événement dure toute la journée. Si vrai, qu’il s’agisse d’un événement d’un seul jour ou de plusieurs jours, l’heure de début et de fin doit être réglée sur minuit et se trouver dans le même fuseau horaire. |
| isCancelled | Boolean | Valeur True si l’événement a été annulé. |
| isDraft | Boolean | Définissez sur true si l’utilisateur a mis à jour la réunion dans Outlook, mais n’a pas envoyé les mises à jour aux participants. Configurez la valeur sur False si toutes les modifications ont été envoyées ou si l’événement est un rendez-vous sans participants. |
| isOnlineMeeting | Valeur booléenne | La valeur est True si cet événement comporte des informations sur une réunion en ligne (autrement dit, onlineMeeting pointe vers une ressource onlineMeetingInfo). Sinon, la valeur est false. La valeur par défaut est false (onlineMeeting est défini sur null). Facultatif. Une fois que vous avez défini la valeur de isOnlineMeeting à true, Microsoft Graph initialise onlineMeeting. Outlook ignore ensuite toute autre modification apportée à isOnlineMeeting, et la réunion reste disponible en ligne. |
| isOrganizer | Boolean | La valeur True est attribuée à cet élément si le propriétaire du calendrier (spécifié par la propriété owner du calendrier) est l’organisateur de l’événement (spécifié par la propriété organizer de l’événement). Cela s’applique également si un délégué a organisé l’événement au nom du propriétaire. |
| isReminderOn | Boolean | Valeur True si une alerte est définie pour rappeler l’événement à l’utilisateur. |
| lastModifiedDateTime | DateTimeOffset | Le type d’horodatage représente les informations de date et d’heure au moyen du format ISO 8601. Il est toujours au format d’heure UTC. Par exemple, le 1er janvier 2014 à minuit UTC se présente comme suit : 2014-01-01T00:00:00Z. |
| location | Location | Emplacement de l’événement. |
| emplacements | Collection emplacement | Emplacements où l’événement est tenu. Les propriétés location et locations se correspondent toujours mutuellement. Si vous mettez à jour la propriété location, tous les emplacements précédents dans la collection locations sont supprimés et remplacés par la nouvelle valeur location. |
| occurrenceId | Chaîne | Identificateur d’une occurrence dans une série d’événements périodiques. Null si l’événement ne fait pas partie d’une série périodique. Le format de la valeur de propriété est OID.{seriesMasterId-value}.{occurrence-start-date}. Le fuseau horaire pour {occurrence-start-date} est la propriété recurrenceTimeZone définie pour recurrenceRange correspondant. Cette propriété peut identifier n’importe quelle occurrence dans une série périodique, y compris une occurrence qui a été modifiée ou annulée. Vous pouvez utiliser cette propriété pour effectuer toutes les opérations prises en charge par les occurrences dans la série périodique. |
| onlineMeeting | OnlineMeetingInfo | Détails pour qu’un participant rejoigne la réunion en ligne. La valeur de cette propriété est définie par défaut sur « null ». En lecture seule. Une fois que vous avez défini les propriétés isOnlineMeeting et onlineMeetingProvider pour activer une réunion en ligne, Microsoft Graph initialise onlineMeeting. Lorsqu’elle est définie, la réunion reste disponible en ligne et vous ne pouvez pas modifier à nouveau les propriétés isOnlineMeeting, onlineMeetingProvider et onlneMeeting . |
| onlineMeetingProvider | onlineMeetingProviderType | Représente le fournisseur de services de réunion en ligne. Par défaut, onlineMeetingProvider est définie sur unknown. Les valeurs possibles sont unknown, teamsForBusiness, skypeForBusiness et skypeForConsumer. Facultatif. Une fois que vous avez défini la valeur de onlineMeetingProvider, Microsoft Graph initialise onlineMeeting. Par la suite, vous ne pouvez plus modifier onlineMeetingProvider et la réunion reste disponible en ligne. |
| onlineMeetingUrl | String | Une URL pour une réunion en ligne. Cette propriété est définie uniquement lorsqu’un organisateur spécifie dans Outlook qu’un événement est une réunion en ligne telle que Skype. Lecture seule. Pour accéder à l’URL permettant de participer à une réunion en ligne, utilisez la valeur joinUrl qui est exposée via la propriété onlineMeeting de l’événement. La propriété onlineMeetingUrl sera bientôt obsolète. |
| organizer | Destinataire | Organisateur de l’événement. |
| originalEndTimeZone | String | Fuseau horaire de fin défini lors de la création de l’événement. La valeur tzone://Microsoft/Custom indique qu’un fuseau horaire personnalisé hérité a été défini dans Outlook bureau. |
| originalStart | DateTimeOffset | Représente l’heure de début d’un événement lors de sa création initiale en tant qu’occurrence ou exception dans une série périodique. Cette propriété n’est pas retournée pour les événements qui sont des instances uniques. Les informations de date et d’heure suivent le format ISO 8601 et sont toujours au format UTC. Par exemple, le 1er janvier 2014 à minuit UTC se présente comme suit : 2014-01-01T00:00:00Z. |
| originalStartTimeZone | String | Fuseau horaire de début défini lors de la création de l’événement. La valeur tzone://Microsoft/Custom indique qu’un fuseau horaire personnalisé hérité a été défini dans Outlook bureau. |
| recurrence | PatternedRecurrence | Modèle de périodicité pour l’événement. |
| reminderMinutesBeforeStart | Int32 | Nombre de minutes avant la date de début de l’événement où l’alerte de rappel a lieu. |
| responseRequested | Boolean | La valeur par défaut est true, ce qui signifie que l’organisateur souhaite qu’un invité envoie une réponse à l’événement. |
| responseStatus | ResponseStatus | Indique le type de réponse envoyé en réponse à un message d’événement. |
| sensitivity | String | Les valeurs possibles sont normal, personal, private, confidential. |
| seriesMasterId | Chaîne | L’ID de la série maîtrise un élément périodique, si cet événement fait partie d’une série périodique. |
| showAs | String | État à afficher. Les valeurs possibles sont free, tentative, busy, oof, workingElsewhere, unknown. |
| start | DateTimeTimeZone | Date, heure et fuseau horaire de début de l’événement. Par défaut, l’heure de début est au format UTC. |
| sujet | String | Texte de la ligne d’objet de l’événement. |
| transactionId | Chaîne | Identificateur personnalisé spécifié par une application cliente pour le serveur afin d’éviter les opérations POST redondantes si le client retente de créer le même événement. Ceci est utile lorsque la connectivité réseau faible entraîne l’expirer le client avant de recevoir une réponse du serveur pour la demande d’événement de création précédente du client. Une fois que vous avez défini transactionId lors de la création d’un événement, vous ne pouvez pas modifier transactionId dans une mise à jour ultérieure. Cette propriété est uniquement renvoyée dans une charge utile de réponse si une application l’a activée. Facultatif. |
| type | String | Type d’événement. Les valeurs possibles sont les suivantes : singleInstance, occurrence, exception, seriesMaster. Lecture seule |
| uid | String | Identificateur unique pour les événements du calendrier. Pour les événements récurrents, la valeur est la même pour le masque des séries que pour toutes ses occurrences, y compris les exceptions. |
| webLink | Chaîne | URL permettant d’ouvrir l’événement dans Outlook sur le web. Outlook sur le web ouvre l’événement dans le navigateur si vous êtes connecté à votre boîte aux lettres. sinon, Outlook sur le web vous invite à vous connecter. Cette URL n’est pas accessible à partir d’un iFrame. |
Remarque
La propriété webLink spécifie une URL qui ouvre l’événement uniquement dans les versions antérieures d’Outlook sur le web. Voici son format d’URL, où {event-id} représente la valeur codée URL de la propriété id :
Pour comptes professionnels ou scolaires :
https://outlook.office365.com/owa/?itemid={event-id}&exvsurl=1&path=/calendar/itemPour les comptes Microsoft :
https://outlook.live.com/owa/?itemid={event-id}&exvsurl=1&path=/calendar/item
Pour ouvrir l’événement dans la version actuelle d’Outlook sur le web, convertissez l’URL dans un des formats suivants et utilisez cette URL pour ouvrir l’événement :
Pour comptes professionnels ou scolaires :
https://outlook.office365.com/calendar/item/{event-id}Pour les comptes Microsoft :
https://outlook.live.com/calendar/item/{event-id}
Relations
| Relation | Type | Description |
|---|---|---|
| pièces jointes | collectionAttachment | Collection des pièces jointes FileAttachment, ItemAttachment, and referenceAttachment l’événement. Propriété de navigation. En lecture seule. Peut avoir la valeur Null. |
| calendrier | Calendar | Calendrier contenant l’événement. Propriété de navigation. En lecture seule. |
| extensions | collection Extension | Collection des extensions d’ouverture définies pour l’événement. Pouvant accepter la valeur Null. |
| instances | collection Événement | Occurrences d’une série périodique, si l’événement est un masque de série. Cette propriété inclut les occurrences qui font partie du modèle de périodicité et les exceptions qui ont été modifiées. Il n’inclut pas les occurrences qui ont été annulées de la série. Propriété de navigation. En lecture seule. Pouvant accepter la valeur Null. |
| multiValueExtendedProperties | collection multiValueLegacyExtendedProperty | Collection des propriétés étendues à valeurs multiples définies pour l’événement. En lecture seule. Pouvant accepter la valeur Null. |
| singleValueExtendedProperties | collection singleValueLegacyExtendedProperty | Collection des propriétés étendues à valeur unique définies pour l’événement. En lecture seule. Pouvant accepter la valeur Null. |
Représentation JSON
La représentation JSON suivante montre le type de ressource.
{
"allowNewTimeProposals": "Boolean",
"attendees": [{"@odata.type": "microsoft.graph.attendee"}],
"body": {"@odata.type": "microsoft.graph.itemBody"},
"bodyPreview": "string",
"cancelledOccurrences":["string"],
"categories": ["string"],
"changeKey": "string",
"createdDateTime": "String (timestamp)",
"end": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
"exceptionOccurrences":["microsoft.graph.event"],
"hasAttachments": true,
"hideAttendees": false,
"iCalUId": "String",
"id": "string (identifier)",
"importance": "String",
"isAllDay": true,
"isCancelled": true,
"isDraft": false,
"isOnlineMeeting": true,
"isOrganizer": true,
"isReminderOn": true,
"lastModifiedDateTime": "String (timestamp)",
"location": {"@odata.type": "microsoft.graph.location"},
"locations": [{"@odata.type": "microsoft.graph.location"}],
"occurrenceId":"string",
"onlineMeeting": {"@odata.type": "microsoft.graph.onlineMeetingInfo"},
"onlineMeetingProvider": "string",
"onlineMeetingUrl": "string",
"organizer": {"@odata.type": "microsoft.graph.recipient"},
"originalEndTimeZone": "string",
"originalStart": "String (timestamp)",
"originalStartTimeZone": "string",
"recurrence": {"@odata.type": "microsoft.graph.patternedRecurrence"},
"reminderMinutesBeforeStart": 1024,
"responseRequested": true,
"responseStatus": {"@odata.type": "microsoft.graph.responseStatus"},
"sensitivity": "String",
"seriesMasterId": "string",
"showAs": "String",
"start": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
"subject": "string",
"type": "String",
"uid": "String",
"webLink": "string",
"attachments": [ { "@odata.type": "microsoft.graph.attachment" } ],
"calendar": { "@odata.type": "microsoft.graph.calendar" },
"extensions": [ { "@odata.type": "microsoft.graph.extension" } ],
"instances": [ { "@odata.type": "microsoft.graph.event" }],
"singleValueExtendedProperties": [ { "@odata.type": "microsoft.graph.singleValueLegacyExtendedProperty" }],
"multiValueExtendedProperties": [ { "@odata.type": "microsoft.graph.multiValueLegacyExtendedProperty" }]
}
Contenu connexe
- Utiliser la requête delta pour suivre les modifications apportées aux données Microsoft Graph
- Obtenir des modifications incrémentielles apportées à des événements dans un dossier
- Ajout de données personnalisées à des ressources à l’aide des extensions
- Ajout de données personnalisées à des utilisateurs à l’aide des extensions d’ouverture
- Ajout de données personnalisées à des groupes à l’aide des extensions de schéma
- Exemple C# de réunions en bloc
- Exemple de réunions en bloc Node.js