Ressourcentyp „event“
Namespace: microsoft.graph
Wichtig
Die APIs unter der /beta
Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.
Ein Ereignis in einem Kalender für einen Benutzer oder der Standardkalender einer Microsoft 365-Gruppe.
Die maximale Anzahl der Teilnehmer an einem Ereignis und die maximale Anzahl der Empfänger einer EventMessage, die von einem Exchange Online-Postfach gesendet wird, beträgt 500. Weitere Informationen erhalten Sie unter Sendelimits.
Diese Ressource unterstützt Folgendes:
- Hinzufügen Ihrer eigenen Daten zu benutzerdefinierten Eigenschaften als Erweiterungen.
- Abonnieren von Änderungsbenachrichtigungen.
- Verwenden einer Delta-Abfrage zum Nachverfolgen von inkrementellen Hinzufügungen, Löschungen und Aktualisierungen durch Bereitstellen der delta-Funktion.
Hinweis: Es gibt einige kleinere Unterschiede in der Weise, wie Sie mit Benutzerkalendern, Gruppenkalendern und den dazugehörigen Ereignissen interagieren können:
- Benutzerkalender können Sie nur in einer CalendarGroup organisieren.
- Sie können Anlagen-Objekte nur zu Ereignissen in Benutzerkalendern, aber nicht zu Ereignissen in Gruppenkalendern hinzufügen.
- Outlook akzeptiert automatisch alle Besprechungsanfragen im Auftrag von Gruppen. Sie können Besprechungsanfragen nur für Benutzerkalenderannehmen, mit Vorbehalt annehmen oder ablehnen.
- Outlook unterstützt keinen Erinnerungen für Gruppenereignisse. Das Erneute Erinnern oder Schließen einer Erinnerung ist nur bei Kalendern für Benutzer möglich.
Methoden
Methode | Rückgabetyp | Beschreibung |
---|---|---|
List | Event-Sammlung | Ruft eine Liste der event-Objekte im Postfach des Benutzers ab. Die Liste enthält einzelne Instanzen von Besprechungen und Serienmaster. |
Create | event | Erstellt ein neues Ereignis durch Veröffentlichen in der Instanzensammlung. |
Get | event | Liest die Eigenschaften und Beziehungen eines Ereignisobjekts. |
Update | event | Aktualisiert das Ereignisobjekt. |
Delete | Keine | Löscht das Ereignisobjekt. |
Endgültig löschen | Keine | Löschen Sie ein Ereignis endgültig, und platzieren Sie es im Ordner Löschvorgänge im Ordner Wiederherstellbare Elemente im Postfach des Benutzers. |
Delta abrufen | Ereignissammlung | Ruft eine Reihe von Ereignissen ab, die in einer calendarView (einem Bereich von Ereignissen) des primären Kalenders des Benutzers hinzugefügt, gelöscht oder aktualisiert wurden. |
Ereignis weiterleiten | Keine | Ermöglicht es dem Organisator oder Teilnehmer eines Besprechungsereignisses, die Besprechungsanfrage an einen neuen Empfänger weiterzuleiten. |
Ereignis abbrechen | Keine | Sendet Absagen vom Organizer an alle Teilnehmer, und die angegebene Besprechung wird abgesagt. |
Accept-Ereignis | Keine | Akzeptiert das angegebene Ereignis in einem Benutzerkalender. |
Mit Vorbehalt akzeptieren | Keine | Akzeptiert mit Vorbehalt das angegebene Ereignis in einem Benutzerkalender. |
Ablehnungsereignis | Keine | Lehnt die Einladung zu einem in einem Benutzerkalender angegebenen Ereignis ab. |
Erinnerung schließen | Keine | Schließt die Erinnerung an das angegebene Ereignis in einem Benutzerkalender. |
Erinnerung „Erneut erinnern“ | Keine | Verschiebt die Erinnerung an das angegebene Ereignis in einem Benutzerkalender bis zu einem neuen Termin. |
Ereignisinstanzen auflisten | Event-Sammlung | Ruft eine Ereignisobjektsammlung ab. |
Anlagen | ||
Anlagen auflisten | Attachment-Sammlung | Ruft alle Anlagen für ein Ereignis ab. |
Anlage hinzufügen | Anlage | Fügt einem Ereignis eine neue Anlage durch Veröffentlichen in der Anlagensammlung hinzu. |
Offene Erweiterungen | ||
Offene Erweiterung erstellen | openTypeExtension | Erstellt eine offene Erweiterung und fügt benutzerdefinierte Eigenschaften zu einer neuen oder vorhandenen Ressource hinzu. |
Offene Erweiterung abrufen | openTypeExtension-Sammlung | Dient zum Abrufen einer offenen Erweiterung, die durch den Erweiterungsnamen identifiziert wird. |
Erweiterte Eigenschaften | ||
Einwertige Eigenschaft erstellen | event | Erstellt eine oder mehrere einwertige erweiterte Eigenschaften in einem neuen oder vorhandenen Ereignis. |
Einwertige Eigenschaft abrufen | event | Ruft mithilfe von $expand oder $filter Ereignisse mit einer bestimmten einwertigen erweiterten Eigenschaft ab. |
Erweiterte mehrwertige Eigenschaft erstellen | event | Erstellt eine oder mehrere mehrwertige erweiterte Eigenschaften in einem neuen oder vorhandenen Ereignis. |
Erweiterte mehrwertige Eigenschaft abrufen | event | Ruft mithilfe von $expand ein Ereignis mit einer bestimmten mehrwertigen erweiterten Eigenschaft ab. |
Eigenschaften
Eigenschaft | Typ | Beschreibung |
---|---|---|
allowNewTimeProposals | Boolescher Wert |
true , wenn der Besprechungsorganisator den eingeladenen Personen erlaubt, bei der Antwort einen neuen Zeitpunkt vorzuschlagen; andernfalls false . Optional. Der Standardwert lautet true . |
attendees | attendee-Sammlung | Die Sammlung der Teilnehmer des Ereignisses. |
body | ItemBody | Der Text der Nachricht, die mit diesem Ereignis verknüpft ist. Er kann im HTML- oder Textformat vorliegen. |
bodyPreview | String | Die Vorschau der Nachricht, die dem Ereignis zugeordnet ist Liegt im Textformat vor. |
cancelledOccurrences | Zeichenfolgenauflistung | Enthält occurrenceId-Eigenschaftswerte abgebrochener Instanzen in einer Serie, wenn das Ereignis der Serienmaster ist. Instanzen in einer Serie, die abgebrochen werden, werden als canceledOccurences bezeichnet. Wird nur bei $select in einem Vorgang Abrufen zurückgegeben, der die ID eines Serienmasterereignisses (d. h. den Eigenschaftswert seriesMasterId) angibt. |
categories | String collection | Die Kategorien, die dem Ereignis zugeordnet sind. Jeder Kategorie entspricht der displayName-Eigenschaft einer für den Benutzer definierten outlookCategory. |
changeKey | String | Gibt die Version des Ereignisobjekts an. Jedes Mal, wenn das Ereignis geändert wird, wird auch die Eigenschaft „changeKey“ geändert. Auf diese Weise kann Exchange Änderungen an der korrekten Version des Objekts vornehmen. |
createdDateTime | DateTimeOffset | Der Typ „Zeitstempel“ stellt die Datums- und Uhrzeitinformationen im Format der ISO 8601 dar und gibt immer die UTC an. Zum Beispiel, Mitternacht UTC am 1. Januar 2014 ist 2014-01-01T00:00:00Z |
end | DateTimeTimeZone | Datum, Uhrzeit und Zeitzone für das Ende des Ereignisses. Standardmäßig ist die Endzeit in UTC angegeben. |
exceptionOccurrences | Ereignissammlung | Enthält die Eigenschaftswerte ID der Ereignisinstanzen, die Ausnahmen in einer periodischen Serie sind. Ausnahmen können sich von anderen Vorkommen in einer periodischen Serie unterscheiden, z. B. Betreff, Start- oder Endzeit oder Teilnehmer. Ausnahmen umfassen keine abgebrochenen Vorkommen. Wird nur bei $select und $expand in einem GET-Vorgang zurückgegeben, der die ID eines Serienmasterereignisses (d. h. den SeriesMasterId-Eigenschaftswert ) angibt. |
hasAttachments | Boolean | „true“, wenn das Ereignis Anlagen hat |
hideAttendees | Boolesch | Wenn auf true gesetzt, dann sieht jeder Teilnehmer nur sich selbst in der Besprechungsanfrage und Besprechungs-Nachverfolgungs-Liste. Der Standardwert ist „false“. |
iCalUId | String | Ein eindeutiger Bezeichner für ein Ereignis in mehreren Kalendern. Diese ID ist für jedes Vorkommen in einer wiederkehrenden Serie unterschiedlich. Schreibgeschützt. |
id | Zeichenfolge | Eindeutiger Bezeichner für das Ereignis.
Standardmäßig ändert sich dieser Wert, wenn das Element von einem Container (z. B. einem Ordner oder Kalender) in einen anderen verschoben wird. Verwenden Sie den Prefer: IdType="ImmutableId" -Header, um dieses Verhalten zu ändern. Weitere Informationen finden Sie unter Abrufen unveränderlicher Bezeichner für Outlook-Ressourcen. Groß-/Kleinschreibung und schreibgeschützt. |
Wichtigkeit | String | Die Wichtigkeit des Ereignisses. Mögliche Werte sind: low , normal und high . |
isAllDay | Boolesch | „true“, wenn das Ereignis ein ganztägiges Ereignis ist Wenn „true“, unabhängig davon, ob es sich um ein ein- oder mehrtägiges Ereignis handelt, müssen Start- und Endzeit auf Mitternacht festgelegt und in derselben Zeitzone sein. |
isCancelled | Boolean | „true“, wenn das Ereignis abgesagt wurde |
isDraft | Boolesch | Legen Sie diesen Wert auf TRUE fest, wenn der Benutzer die Besprechung in Outlook aktualisiert, die Updates jedoch nicht an die Teilnehmer gesendet hat. "false", wenn alle Änderungen gesendet wurden oder wenn es sich bei dem Ereignis um einen Termin ohne Teilnehmer handelt. |
isOnlineMeeting | Boolesch |
True wenn dieses Ereignis Online-Meeting-Informationen enthält (d.h. onlineMeeting verweist auf eine onlineMeetingInfo-Ressource), andernfalls false . Der Standardwert lautet false (onlineMeeting istnull ). Optional. Nachdem Sie isOnlineMeeting auf true gesetzt haben, initialisiert Microsoft Graph onlineMeeting. Outlook ignoriert dann alle weiteren Änderungen an isOnlineMeeting, und die Besprechung bleibt online verfügbar. |
isOrganizer | Boolesch | Legen Sie den Wert auf "true" fest, wenn der Kalenderbesitzer (durch die Eigenschaft Besitzer des Kalenders) der Organisator des Ereignisses ist (angegeben durch die Eigenschaft Organisator des Ereignisses). Dies gilt auch, wenn eine Stellvertretung das Ereignis im Namen des Besitzers organisiert hat. |
isReminderOn | Boolean | „true“, wenn eingestellt ist, dass der Benutzer an das Ereignis erinnert werden soll |
lastModifiedDateTime | DateTimeOffset | Der Typ „Zeitstempel“ stellt die Datums- und Uhrzeitinformationen im Format der ISO 8601 dar und gibt immer die UTC an. Zum Beispiel, Mitternacht UTC am 1. Januar 2014 ist 2014-01-01T00:00:00Z |
location | Ort | Der Ort des Ereignisses. |
locations | Location-Sammlung | Die Orte, an denen die Veranstaltung stattfindet. Die Eigenschaften location und locations entsprechen sich immer gegenseitig. Wenn Sie die location-Eigenschaft aktualisieren, werden alle früheren Orte in der locations-Sammlung entfernt und durch den neuen location-Wert ersetzt. |
occurrenceId | Zeichenfolge | Ein Bezeichner für ein Vorkommen in einer periodischen Ereignisserie. Null, wenn das Ereignis nicht Teil einer Serie ist. Das Format des Eigenschaftswerts ist „OID.{seriesMasterId-value}.{occurrence-start-date}“. Die Zeitzone für {occurrence-start-date} ist die Eigenschaft „recurrenceTimeZone“, die für den entsprechenden recurrenceRange definiert ist. Diese Eigenschaft kann jedes Vorkommen in einer Serie identifizieren, einschließlich eines Ereignisses, das geändert oder abgebrochen wurde. Mithilfe dieser Eigenschaft können Sie alle Vorgänge ausführen, die von Vorkommen in der Serie unterstützt werden. |
onlineMeeting | OnlineMeetingInfo | Details für einen Teilnehmer, um online an der Besprechung teilzunehmen. Der Standardwert ist null. Schreibgeschützt. Sobald Sie die Eigenschaften isOnlineMeeting und onlineMeetingProvider festgelegt haben, um eine Besprechung online zu aktivieren, initialisiert Microsoft Graph onlineMeeting. Wenn festgelegt, bleibt die Besprechung online verfügbar, und Sie können die Eigenschaften isOnlineMeeting, onlineMeetingProvider und onlneMeeting nicht mehr ändern. |
onlineMeetingProvider | onlineMeetingProviderType | Stellt den Dienstanbieter für die Onlinebesprechung dar. Standardmäßig ist onlineMeetingProviderunknown . Die gültigen Werte sind unknown , teamsForBusiness , skypeForBusiness und skypeForConsumer . Optional. Nachdem Sie onlineMeetingProvider festgelegt haben, initialisiert Microsoft Graph onlineMeeting. Anschließend können Sie onlineMeetingProvider nicht mehr ändern, und die Besprechung bleibt online verfügbar. |
onlineMeetingUrl | String | Eine URL für eine Onlinebesprechung. Die Eigenschaft wird nur festgelegt, wenn ein Veranstalter in Outlook angibt, dass es sich bei einer Veranstaltung um eine Onlinebesprechung wie Skype handelt. Schreibgeschützt. Um auf die URL zuzugreifen, um an einer Onlinebesprechung teilzunehmen, verwenden Sie joinUrl, die über die Eigenschaft onlineMeeting der Veranstaltung angezeigt wird. Die Eigenschaft onlineMeetingUrl wird in Zukunft nicht mehr unterstützt. |
organizer | Empfänger | Der Organisator des Ereignisses. |
originalEndTimeZone | String | Die Zeitzone, die bei der Erstellung des Ereignisses für das Ereignisende festgelegt wurde. Der Wert tzone://Microsoft/Custom gibt an, dass eine ältere benutzerdefinierte Zeitzone in Outlook Desktop festgelegt wurde. |
originalStart | DateTimeOffset | Stellt die Startzeit eines Ereignisses dar, wenn es anfänglich als Vorkommen oder Ausnahme in einer Serie erstellt wird. Diese Eigenschaft wird nicht für Ereignisse zurückgegeben, die einzelne Instanzen sind. Seine Datums- und Uhrzeitinformationen werden im ISO 8601-Format ausgedrückt und immer in UTC angegeben. Zum Beispiel, Mitternacht UTC am 1. Januar 2014 ist 2014-01-01T00:00:00Z |
originalStartTimeZone | String | Die Zeitzone, die bei der Erstellung des Ereignisses für den Ereignisbeginn festgelegt wurde. Der Wert tzone://Microsoft/Custom gibt an, dass eine ältere benutzerdefinierte Zeitzone in Outlook Desktop festgelegt wurde. |
recurrence | PatternedRecurrence | Das Serienmuster für das Ereignis. |
reminderMinutesBeforeStart | Int32 | Festlegung, wie viele Minuten vor Beginn des Ereignisses die Erinnerung angezeigt werden soll |
responseRequested | Boolesch | Der Standardwert ist "true", was bedeutet, dass der Organisator von eingeladenen Personen eine Antwort auf die Veranstaltung wünscht. |
responseStatus | ResponseStatus | Typ der Antwort, die als Antwort auf eine Ereignisnachricht gesendet wurde. |
sensitivity | String | Mögliche Werte: normal , personal , private , confidential |
seriesMasterId | String | Die ID für das Terminserien-Masterelement, wenn das Ereignis zu einer Terminserie gehört. |
showAs | Zeichenfolge | Der anzuzeigende Status. Mögliche Werte sind: free , tentative , busy , oof , workingElsewhere und unknown . |
start | DateTimeTimeZone | Startdatum, Uhrzeit und Zeitzone des Ereignisses. Standardmäßig ist die Startzeit in UTC angegeben. |
subject | String | Der Text der Betreffzeile des Ereignisses |
transactionId | Zeichenfolge | Ein benutzerdefinierter Bezeichner, der von einer Client-App für den Server angegeben wird, um redundante POST-Vorgänge zu vermeiden, wenn der Client wiederholt, um dasselbe Ereignis zu erstellen. Dies ist nützlich, wenn geringe Netzwerkkonnektivität dazu führt, dass der Client eine Zeitüberschreitung ausgibt, bevor eine Antwort vom Server für die Anforderung des Clients vor der Ereigniserstellung eingeht. Nachdem Sie beim Erstellen eines Ereignisses transactionId festgelegt haben, können Sie transactionId in einem nachfolgenden Update nicht mehr ändern. Diese Eigenschaft wird nur bei einer Antwortnutzlast zurückgegeben, wenn sie von einer App festgelegt wurde. Optional. |
type | Zeichenfolge | Der Ereignistyp. Mögliche Werte: singleInstance , occurrence , exception , seriesMaster . Schreibgeschützt |
uid | Zeichenfolge | Ein eindeutiger Bezeichner für Kalenderereignisse. Bei wiederkehrenden Ereignissen ist der Wert für den Serienmaster und alle seine Vorkommen einschließlich Ausnahmen identisch. |
webLink | Zeichenfolge | Die URL zum Öfnen des Ereignisses in Outlook im Web. Outlook im Web öffnet das Ereignis im Browser, wenn Sie bei Ihrem Postfach angemeldet sind. Andernfalls werden Sie von Outlook im Web aufgefordert, sich anzumelden. Auf diese URL kann nicht innerhalb eines iFrames zugegriffen werden. |
Hinweis
Die Eigenschaft webLink gibt eine URL an, die das Ereignis nur in früheren Versionen von Outlook im Web öffnet. Im Folgenden ist das URL-Format dargestellt, wobei {event-id} der URL-codierte Wert der id-Eigenschaft ist:
Geschäfts-, Schul- oder Unikonten:
https://outlook.office365.com/owa/?itemid={event-id}&exvsurl=1&path=/calendar/item
Microsoft-Konten:
https://outlook.live.com/owa/?itemid={event-id}&exvsurl=1&path=/calendar/item
Um das Ereignis in einer aktuellen Version von Outlook im Web zu öffnen, konvertieren Sie die URL in eines der folgenden Formate, und verwenden Sie diese URL zum Öffnen des Ereignisses:
Geschäfts-, Schul- oder Unikonten:
https://outlook.office365.com/calendar/item/{event-id}
Microsoft-Konten:
https://outlook.live.com/calendar/item/{event-id}
Beziehungen
Beziehung | Typ | Beschreibung |
---|---|---|
Anlagen | Attachment-Sammlung | Die Sammlung der FileAttachment-, ItemAttachment- und referenceAttachment-Anlagen für das Ereignis. Navigationseigenschaft. Schreibgeschützt. Lässt Nullwerte zu. |
Kalender | Kalender | Der Kalender, der das Ereignis enthält. Navigationseigenschaft. Schreibgeschützt |
Erweiterungen | Erweiterungssammlung | Die Sammlung der für das Ereignis definierten offenen Erweiterungen. Nullwerte zulassend. |
instances | Event-Sammlung | Die Vorkommen einer periodischen Serie, wenn es sich um einen Serienmaster handelt. Diese Eigenschaft enthält Vorkommen, die Teil des Serienmusters sind, und Ausnahmen, die geändert wurden. Es enthält keine Vorkommen, die aus der Reihe abgebrochen wurden. Navigationseigenschaft. Schreibgeschützt. Nullwerte zulassend. |
multiValueExtendedProperties | multiValueLegacyExtendedProperty-Sammlung | Die Sammlung der für das Ereignis definierten mehrwertigen erweiterten Eigenschaften. Schreibgeschützt. Nullwerte zulassend. |
singleValueExtendedProperties | singleValueLegacyExtendedProperty-Sammlung | Die Sammlung der für das Ereignis definierten einwertigen erweiterten Eigenschaften. Schreibgeschützt. Nullwerte zulassend. |
JSON-Darstellung
Die folgende JSON-Darstellung veranschaulicht den Ressourcentyp.
{
"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" }]
}
Verwandte Inhalte
- Verwenden einer Delta-Abfrage zum Nachverfolgen von Änderungen in Microsoft Graph-Daten
- Inkrementelle Änderungen an Ereignissen in einem Ordner abrufen
- Hinzufügen von benutzerdefinierten Daten zu Ressourcen mithilfe von Erweiterungen
- Hinzufügen von benutzerdefinierten Daten zu Benutzern mithilfe offener Erweiterungen
- Hinzufügen von benutzerdefinierten Daten zu Gruppen mithilfe von Schemaerweiterungen
- C#-Beispiel für Massenbesprechungen
- Beispiel für Massenbesprechungen Node.js