Ressourcentyp „event“
Namespace: microsoft.graph
Wichtig
APIs unter der /beta Version in Microsoft Graph können geändert werden. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in Version 1.0 verfügbar ist, verwenden Sie die Versionsauswahl .
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 finden Sie unter Sendegrenzen.
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. Das Annehmen, Mit Vorbehalt annehmen oder Ablehnen von Besprechungsanfragen ist nur bei Kalendern für Benutzer möglich.
- 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 |
|---|---|---|
| Ereignisse auflisten | Event-Sammlung | Ruft eine Liste der event-Objekte im Postfach des Benutzers ab. Die Liste enthält einzelne Instanzen von Besprechungen und Serienmaster. |
| Ereignis erstellen | event | Erstellt ein neues Ereignis durch Veröffentlichen in der Instanzensammlung. |
| Get event | event | Liest die Eigenschaften und Beziehungen eines Ereignisobjekts. |
| Update | event | Aktualisiert das Ereignisobjekt. |
| Delete | Keine | Löscht das Ereignisobjekt. |
| delta | event-Sammlung | Dient zum Abrufen einer Reihe von Ereignissen, die in einer calendarView (ein Bereich von Ereignissen) im primären Kalender des Benutzers hinzugefügt, gelöscht oder aktualisiert wurden. |
| forward | Keine | Ermöglicht es dem Organisator oder Teilnehmer eines Besprechungsereignisses, die Besprechungsanfrage an einen neuen Empfänger weiterzuleiten. |
| cancel | Keine | Sendet Absagen vom Organizer an alle Teilnehmer, und die angegebene Besprechung wird abgesagt. |
| accept | Keine | Akzeptiert das angegebene Ereignis in einem Benutzerkalender. |
| tentativelyAccept | Keine | Akzeptiert mit Vorbehalt das angegebene Ereignis in einem Benutzerkalender. |
| decline | Keine | Lehnt die Einladung zu einem in einem Benutzerkalender angegebenen Ereignis ab. |
| dismissReminder | Keine | Schließt die Erinnerung an das angegebene Ereignis in einem Benutzerkalender. |
| snoozeReminder | Keine | Verschiebt die Erinnerung an das angegebene Ereignis in einem Benutzerkalender bis zu einem neuen Termin. |
| List instances | 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. |
| Schemaerweiterungen | ||
| Schemaerweiterungswerte hinzufügen | Dient zum Erstellen einer Schemaerweiterungsdefinition und anschließenden Verwenden der Definition zum Hinzufügen benutzerdefinierter typisierter Daten zu einer Ressource. | |
| Erweiterte Eigenschaften | ||
| Create single-value extended property | event | Erstellt eine oder mehrere einwertige erweiterte Eigenschaften in einem neuen oder vorhandenen Ereignis. |
| Get event with single-value extended property | event | Ruft mithilfe von $expand oder $filter Ereignisse mit einer bestimmten einwertigen erweiterten Eigenschaft ab. |
| Create multi-value extended property | event | Erstellt eine oder mehrere mehrwertige erweiterte Eigenschaften in einem neuen oder vorhandenen Ereignis. |
| Get event with multi-value extended property | 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 eingeladenen Personen erlaubt, beim Antworten eine neue Uhrzeit vorzuschlagen; andernfalls false. Optional. Der Standardwert ist true. |
| attendees | attendee-Sammlung | Die Sammlung der Teilnehmer des Ereignisses. |
| body | ItemBody | Der Text der Nachricht, die dem Ereignis zugeordnet 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 die Eigenschaftswerte occurrenceId von abgebrochenen Instanzen in einer periodischen Serie, wenn das Ereignis den Serienmaster darstellt. Instanzen einer periodischen Serie, die abgebrochen werden, werden als „cancelledOccurences“ 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 dem Ereignis zugeordneten Kategorien. Jede 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 Timestamp-Typ stellt die Datums- und Uhrzeitinformationen mithilfe des ISO 8601-Formats dar und wird immer in UTC-Zeit angegeben. Mitternacht UTC-Zeit am 1. Januar 2014 ist beispielsweise 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 schließen keine abgebrochenen Vorkommen ein. Wird nur bei $select und $expand in einem Vorgang ABRUFEN zurückgegeben, der die ID eines Serienmasterereignisses (d. h. den Eigenschaftswert seriesMasterId) angibt. |
| hasAttachments | Boolean | „true“, wenn das Ereignis Anlagen hat |
| hideAttendees | Boolesch | Bei der Einstellung auf true, sieht sich jeder Teilnehmer nur in der Liste der Besprechungsanfrage und in der Liste zur Verfolgung der Besprechung. Der Standardwert ist falsch. |
| 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, high. |
| isAllDay | Boolesch | „true“, wenn das Ereignis ein eintägiges Ereignis ist. Wenn „true“, dann müssen Start- und Endzeit auf Mitternacht festgelegt und in derselben Zeitzone sein, unabhängig davon, ob es sich um ein ein- oder mehrtägiges Ereignis handelt. |
| isCancelled | Boolean | „true“, wenn das Ereignis abgesagt wurde |
| isDraft | Boolesch | "true", wenn der Benutzer die Besprechung in Outlook aktualisiert, aber 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 Onlinebesprechungsinformationen enthält (d. h. onlineMeeting verweist auf eine onlineMeetingInfo-Ressource), andernfalls false. Der Standardwert ist false (onlineMeeting ist null). Optional.Nachdem Sie isOnlineMeeting auf true gesetzt haben, initialisiert Microsoft Graph onlineMeeting. Anschließend ignoriert Outlook alle weiteren Änderungen zu isOnlineMeeting, und das Meeting 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 Timestamp-Typ stellt die Datums- und Uhrzeitinformationen mithilfe des ISO 8601-Formats dar und wird immer in UTC-Zeit angegeben. Mitternacht UTC-Zeit am 1. Januar 2014 ist beispielsweise 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 periodischen 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 periodischen Serie erkennen, einschließlich eines Vorkommens, das geändert oder gelöscht 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. Einmal eingerichtet, 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 angegeben, wenn ein Organisator ein Ereignis in Outlook als Onlinebesprechung festlegt, z. B. Skype. Schreibgeschützt. Um auf die URL zur Teilnahme an einer Onlinebesprechung zuzugreifen, verwenden Sie joinUrl, die über die Eigenschaft onlineMeeting des Ereignisses angezeigt wird. Die Eigenschaft onlineMeetingUrl ist bald veraltet. |
| 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 wiederkehrenden Serie erstellt wird. Diese Eigenschaft wird nicht für Ereignisse zurückgegeben, bei denen es sich um einzelne Instanzen handelt. 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 erneut versucht, 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, ist es nicht möglich, transactionId in einer nachfolgenden Aktualisierung zu ä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. Diese Eigenschaft ersetzt die aktuelle iCalUid-Eigenschaft, die in der Ereignisressourcedefiniert und für jede Instanz einer Serie unterschiedlich ist. |
| 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 aus einem iFrame heraus nicht 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/itemMicrosoft-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 des Ereignisses. Navigationseigenschaft. Schreibgeschützt. Nullwerte zulassend. |
| Kalender | Kalender | Der Kalender, der das Ereignis enthält. Navigationseigenschaft. Schreibgeschützt. |
| Erweiterungen | Erweiterungssammlung | Die Sammlung der für das Ereignis definierten offenen Erweiterungen. Nullwert. |
| instances | Event-Sammlung | Die Vorkommen einer periodischen Serie, wenn es sich um einen Serienmaster handelt. Diese Eigenschaft umfasst Vorkommen, die Teil des Serienmusters sind, und Ausnahmen, die geändert wurden, nicht jedoch Vorkommen, die aus der Serie abgebrochen wurden. Navigationseigenschaft. Schreibgeschützt. Lässt NULL-Werte zu. |
| multiValueExtendedProperties | multiValueLegacyExtendedProperty-Sammlung | Die Sammlung der für das Ereignis definierten mehrwertigen erweiterten Eigenschaften. Schreibgeschützt. Lässt Nullwerte zu. |
| singleValueExtendedProperties | singleValueLegacyExtendedProperty-Sammlung | Die Sammlung der für das Ereignis definierten einwertigen erweiterten Eigenschaften. Schreibgeschützt. Lässt Nullwerte zu. |
JSON-Darstellung
Es folgt eine JSON-Darstellung der 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,
"uid": "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",
"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" }]
}
Siehe auch
- 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
Feedback
Feedback senden und anzeigen für