Ereignis abrufen
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.
Dient zum Abrufen der Eigenschaften und Beziehungen des angegebenen event-Objekts.
Eine App kann ein Ereignis im Kalender eines anderen Benutzers abrufen, wenn:
- Die App verfügt über Anwendungsberechtigungen.
- Die App verfügt über die entsprechenden delegierten Berechtigungen eines Benutzers, und ein anderer Benutzer hat einen Kalender für diesen Benutzer freigegeben oder diesem Benutzer delegierten Zugriff gewährt. Hier finden Sie weitere Informationen und ein Beispiel.
Da die EreignisressourceErweiterungen unterstützt, können Sie den GET
Vorgang auch verwenden, um benutzerdefinierte Eigenschaften und Erweiterungsdaten in einer Ereignisinstanz abzurufen.
Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.
Globaler Dienst | US Government L4 | US Government L5 (DOD) | China, betrieben von 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Unterstützen verschiedener Zeitzonen
Für alle GET-Vorgänge, die Ereignisse zurückgeben, können Sie den Prefer: outlook.timezone
-Header zum Angeben der Zeitzone für die Anfangs- und Endzeit des Ereignisses in der Antwort verwenden.
Mit dem folgenden Prefer: outlook.timezone
-Header werden zum Beispiel die Anfangs- und Endzeiten in der Antwort auf EST festgelegt.
Prefer: outlook.timezone="Eastern Standard Time"
Wenn das Ereignis in einer anderen Zeitzone erstellt wurde, werden die Anfangs- und Endzeiten an die in diesem Prefer
-Header angegebene Zeitzone angepasst.
Die unterstützten Zeitzonen finden Sie in dieser Liste. Wenn der Prefer: outlook.timezone
-Header nicht angegeben ist, werden die Anfangs- und Endzeiten in UTC zurückgegeben.
Sie können die OriginalStartTimeZone- und OriginalEndTimeZone-Eigenschaften für die event-Ressource verwenden, um die beim Erstellen des Ereignisses verwendete Zeitzone abzurufen.
Berechtigungen
Wählen Sie für diese API die Als am wenigsten privilegierten Berechtigungen gekennzeichneten Berechtigungen aus. Verwenden Sie nur dann eine Berechtigung mit höheren Berechtigungen , wenn dies für Ihre App erforderlich ist. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.
Berechtigungstyp | Berechtigungen mit den geringsten Berechtigungen | Berechtigungen mit höheren Berechtigungen |
---|---|---|
Delegiert (Geschäfts-, Schul- oder Unikonto) | Calendars.ReadBasic | Calendars.Read |
Delegiert (persönliches Microsoft-Konto) | Calendars.ReadBasic | Calendars.Read |
Anwendung | Calendars.ReadBasic | Calendars.Read |
HTTP-Anforderung
GET /me/events/{id}
GET /users/{id | userPrincipalName}/events/{id}
GET /groups/{id}/events/{id}
GET /me/calendar/events/{id}
GET /users/{id | userPrincipalName}/calendar/events/{id}
GET /groups/{id}/calendar/events/{id}
GET /me/calendars/{id}/events/{id}
GET /users/{id | userPrincipalName}/calendars/{id}/events/{id}
GET /me/calendarGroups/{id}/calendars/{id}/events/{id}
GET /users/{id | userPrincipalName}/calendarGroups/{id}/calendars/{id}/events/{id}
Optionale Abfrageparameter
Diese Methode unterstützt die OData-Abfrageparameter zur Anpassung der Antwort.
Anforderungsheader
Name | Typ | Beschreibung |
---|---|---|
Authorization | string | Bearer {token}. Erforderlich. Erfahren Sie mehr über die Authentifizierung und Autorisierung. |
Prefer: outlook.timezone | string | Verwenden Sie dies, um die Zeitzone für die Anfangs- und Endzeiten in der Antwort anzugeben. Wenn nicht angegeben, werden diese Zeitwerte in UTC zurückgegeben. Optional. |
Besser: outlook.body-content-type | string | Das Format, in der die body-Eigenschaft zurückgegeben werden soll. Werte können „Text“ oder „html“ sein. Als Bestätigung wird eine Preference-Applied -Kopfzeile zurückgegeben, wenn diese Prefer -Kopfzeile angegeben ist. Wenn der Header nicht angegeben wird, wird die body-Eigenschaft im HTML-Format zurückgegeben. Optional. |
Anforderungstext
Geben Sie keinen Anforderungstext für diese Methode an.
Antwort
Wenn die Methode erfolgreich verläuft, werden der Antwortcode 200 OK
und ein event-Objekt im Antworttext zurückgegeben.
Beispiele
Beispiel 1: Abrufen eines angegebenen Ereignisses
Anforderung
Im folgenden Beispiel wird das angegebene Ereignis abgerufen. Es gibt Folgendes an:
- Einen
Prefer: outlook.timezone
-Header zum Abrufen von Datums- und Uhrzeitwerten in Pacific Normalzeit. - Ein
$select
Abfrageparameter zum Zurückgeben bestimmter Eigenschaften. Ohne$select
-Parameter werden alle Ereigniseigenschaften zurückgegeben.
Die Anforderung gibt keinen Prefer: outlook.body-content-type
-Header an, um ein bestimmtes Format für den zurückgegebenen Ereignistext anzuzeigen.
GET https://graph.microsoft.com/beta/me/events/AAMkAGIAAAoZDOFAAA=?$select=subject,body,bodyPreview,organizer,attendees,start,end,location,hideAttendees
Prefer: outlook.timezone="Pacific Standard Time"
Antwort
Das folgende Beispiel zeigt die Antwort. Da kein Prefer: outlook.body-content-type
-Header angegeben wurde, wird die body-Eigenschaft im standardmäßigen HTML-Format zurückgegeben.
HTTP/1.1 200 OK
Content-type: application/json
Preference-Applied: outlook.timezone="Pacific Standard Time"
{
"@odata.context":"https://graph.microsoft.com/beta/$metadata#users('cd209b0b-3f83-4c35-82d2-d88a61820480')/events(subject,body,bodyPreview,organizer,attendees,start,end,location,hideAttendees)/$entity",
"@odata.etag":"W/\"ZlnW4RIAV06KYYwlrfNZvQAAKGWwbw==\"",
"id":"AAMkAGIAAAoZDOFAAA=",
"iCalUId": "040000008200E00074=",
"uid": "040000008200E00074C=",
"subject":"Orientation ",
"bodyPreview":"Dana, this is the time you selected for our orientation. Please bring the notes I sent you.",
"body":{
"contentType":"html",
"content":"<html><head></head><body><p>Dana, this is the time you selected for our orientation. Please bring the notes I sent you.</p></body></html>"
},
"start":{
"dateTime":"2017-04-21T10:00:00.0000000",
"timeZone":"Pacific Standard Time"
},
"end":{
"dateTime":"2017-04-21T12:00:00.0000000",
"timeZone":"Pacific Standard Time"
},
"location": {
"displayName": "Assembly Hall",
"locationType": "default",
"uniqueId": "Assembly Hall",
"uniqueIdType": "private"
},
"locations": [
{
"displayName": "Assembly Hall",
"locationType": "default",
"uniqueIdType": "unknown"
}
],
"attendees":[
{
"type":"required",
"status":{
"response":"none",
"time":"0001-01-01T00:00:00Z"
},
"emailAddress":{
"name":"Samantha Booth",
"address":"samanthab@contoso.com"
}
},
{
"type":"required",
"status":{
"response":"tentativelyAccepted",
"time":"0001-01-01T00:00:00Z"
},
"proposedNewTime": {
"start": {
"dateTime": "2019-08-16T12:00:00.0000000",
"timeZone": "Pacific Standard Time"
},
"end": {
"dateTime": "2019-08-16T14:00:00.0000000",
"timeZone": "Pacific Standard Time"
}
},
"emailAddress":{
"name":"Dana Swope",
"address":"danas@contoso.com"
}
}
],
"hideAttendees": false,
"organizer":{
"emailAddress":{
"name":"Samantha Booth",
"address":"samanthab@contoso.com"
}
}
}
Beispiel 2: Abrufen der Body-Eigenschaft im Textformat
Anforderung
Im folgenden Beispiel wird gezeigt, wie sie mithilfe eines Prefer: outlook.body-content-type="text"
Headers die body-Eigenschaft des angegebenen Ereignisses im Textformat abrufen.
Die Anforderung verwendet auch einen $select
-Abfrageparameter zum Zurückgeben bestimmter Eigenschaften. Ohne $select
-Parameter werden alle Ereigniseigenschaften zurückgegeben.
GET https://graph.microsoft.com/beta/me/events/AAMkAGI1AAAoZDOFAAA=?$select=subject,body,bodyPreview
Prefer: outlook.body-content-type="text"
Antwort
Das folgende Beispiel zeigt die Antwort. Die body-Eigenschaft wird im Textformat zurückgegeben.
HTTP/1.1 200 OK
Content-type: application/json
Preference-Applied: outlook.body-content-type="text"
{
"@odata.context":"https://graph.microsoft.com/beta/$metadata#users('cd209b0b-3f83-4c35-82d2-d88a61820480')/events(subject,body,bodyPreview)/$entity",
"@odata.etag":"W/\"ZlnW4RIAV06KYYwlrfNZvQAAKGWwbw==\"",
"id":"AAMkAGI1AAAoZDOFAAA=",
"iCalUId": "040000008200E00074=",
"uid": "040000008200E00074C=",
"subject":"Orientation ",
"bodyPreview":"Dana, this is the time you selected for our orientation. Please bring the notes I sent you.",
"body":{
"contentType":"text",
"content":"Dana, this is the time you selected for our orientation. Please bring the notes I sent you.\r\n"
}
}
Beispiel 3: Abrufen eines Ereignisses, das mehrere Speicherorte angibt
Anforderung
Das folgende Beispiel zeigt das Abrufen eines Ereignisses, das mehrere Speicherorte angibt. Die Anforderung gibt einen $select
-Abfrageparameter zum Zurückgeben bestimmter Eigenschaften an.
GET https://graph.microsoft.com/beta/me/events/AAMkADAGAADDdm4NAAA=?$select=subject,body,bodyPreview,organizer,attendees,start,end,location,locations
Antwort
Das folgende Beispiel zeigt die Antwort. Die locations-Eigenschaft umfasst Details für die drei Orte, für die das Ereignis organisiert wird.
Da die Anforderung keine Prefer: outlook.timezone
- oder Prefer: outlook.body-content-type
-Header angibt, werden die Start- und Endeigenschaften in der UTC-Standardzeitzone und der Text im HTML-Standardformat angezeigt.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context":"https://graph.microsoft.com/beta/$metadata#users('d1a2fae9-db66-4cc9-8133-2184c77af1b8')/events(subject,body,bodyPreview,organizer,attendees,start,end,location,locations)/$entity",
"@odata.etag":"W/\"y53lbKh6jkaxHzFwGhgyxgAAw5zhug==\"",
"id":"AAMkADAGAADDdm4NAAA=",
"iCalUId": "040000008200E00074=",
"uid": "040000008200E00074C=",
"subject":"Plan summer company picnic",
"bodyPreview":"Let's kick-start this event planning!",
"body":{
"contentType":"html",
"content":"<html>\r\n<head>\r\n</head>\r\n<body>\r\nLet's kick-start this event planning!\r\n</body>\r\n</html>\r\n"
},
"start":{
"dateTime":"2017-08-30T11:00:00.0000000",
"timeZone":"UTC"
},
"end":{
"dateTime":"2017-08-30T12:00:00.0000000",
"timeZone":"UTC"
},
"location":{
"displayName":"Conf Room 3; Fourth Coffee; Home Office",
"locationType":"default",
"uniqueId":"Conf Room 3; Fourth Coffee; Home Office",
"uniqueIdType":"private"
},
"locations":[
{
"displayName":"Conf Room 3",
"locationType":"default",
"uniqueIdType":"unknown"
},
{
"displayName":"Fourth Coffee",
"locationType":"default",
"uniqueId":"Fourth Coffee",
"uniqueIdType":"private",
"address":{
"type":"unknown",
"street":"4567 Main St",
"city":"Redmond",
"state":"WA",
"countryOrRegion":"US",
"postalCode":"32008"
},
"coordinates":{
"latitude":47.672,
"longitude":-102.103
}
},
{
"displayName":"Home Office",
"locationType":"default",
"uniqueIdType":"unknown"
}
],
"attendees":[
{
"type":"required",
"status":{
"response":"none",
"time":"0001-01-01T00:00:00Z"
},
"emailAddress":{
"name":"Dana Swope",
"address":"DanaS@contoso.com"
}
},
{
"type":"required",
"status":{
"response":"none",
"time":"0001-01-01T00:00:00Z"
},
"emailAddress":{
"name":"Alex Wilber",
"address":"AlexW@contoso.com"
}
}
],
"organizer":{
"emailAddress":{
"name":"Adele Vance",
"address":"AdeleV@contoso.com"
}
}
}
Beispiel 4: Erweitern eines Serienmasterereignisses
Anforderung
Das folgende Beispiel zeigt das Erweitern eines Serienmasterereignisses einer Serie mit Ausnahmen und abgebrochenen Ereignissen. Die Anforderung gibt einen $select
-Abfrageparameter zum Zurückgeben bestimmter Eigenschaften an.
GET https://graph.microsoft.com/beta/me/events/AAMkADAGAADDdm4NAAA=?$select=subject,start,end,occurrenceId,exceptionOccurrences,cancelledOccurrences&$expand=exceptionOccurrences
Antwort
Der GET-Vorgang gibt die ausgewählten Eigenschaften für das Serienmasterereignis zurück. Insbesondere für Ereignisse in der exceptionOccurrences-Auflistung gibt der Vorgang die Id-Eigenschaft und die entsprechenden ausgewählten Eigenschaften (subject, start, end, occurrenceId) zurück. Bei Ereignissen in der cancelledOccurrences-Auflistung gibt der Vorgang nur ihre occurrenceId-Eigenschaftswerte zurück, da die Ereignisse nicht mehr vorhanden sind.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context":"https://graph.microsoft.com/beta/$metadata#users('d1a2fae9-db66-4cc9-8133-2184c77af1b8')/events(subject,start,end,occurrenceId,exceptionOccurrences,cancelledOccurrences)/$entity",
"@odata.etag":"W/\"y53lbKh6jkaxHzFwGhgyxgAAw5zhug==\"",
"id":"AAMkADAGAADDdm4NAAA=",
"iCalUId": "040000008200E00074=",
"uid": "040000008200E00074C=",
"subject": "Daily stand-up",
"cancelledOccurrences": [
"OID.AAMkADAGAADDdm4NAAA=.2020-04-30",
"OID.AAMkADAGAADDdm4NAAA=.2020-05-07",
"OID.AAMkADAGAADDdm4NAAA=.2020-05-14"
],
"occurrenceId": null,
"start": {
"dateTime": "2020-04-23T11:30:00.0000000",
"timeZone": "UTC"
},
"end": {
"dateTime": "2020-04-23T12:00:00.0000000",
"timeZone": "UTC"
},
"exceptionOccurrences": [
{
"id": "AAMkADM0ZGRhMjdjLTA==",
"Subject": "SM update 24",
"occurrenceId": "OID.AAMkADAGAADDdm4NAAA=.2020-05-21",
"start": {
"dateTime": "2020-05-21T11:30:00.0000000",
"timeZone": "UTC"
},
"end": {
"dateTime": "2020-05-21T12:00:00.0000000",
"timeZone": "UTC"
}
}
]
}
Verwandte Inhalte
Feedback
https://aka.ms/ContentUserFeedback.
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unterFeedback senden und anzeigen für