Feedback Bearbeiten

Ereignis abrufen

  • Artikel
  • 16 Minuten Lesedauer

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 .

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 von einem Benutzer, 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 Ereignisressource Erweiterungen unterstützt, können Sie den GET Vorgang auch verwenden, um benutzerdefinierte Eigenschaften und Erweiterungsdaten in einer Ereignisinstanz abzurufen.

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

Eine der nachfolgenden Berechtigungen ist erforderlich, um diese API aufrufen zu können. Weitere Informationen, unter anderem zur Auswahl von Berechtigungen, finden Sie im Artikel zum Thema Berechtigungen.

Berechtigungstyp Berechtigungen (von der Berechtigung mit den wenigsten Rechten zu der mit den meisten Rechten)
Delegiert (Geschäfts-, Schul- oder Unikonto) Calendars.Read
Delegiert (persönliches Microsoft-Konto) Calendars.Read
Anwendung 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.
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 die Kopfzeile nicht angegeben ist, wird die body-Eigenschaft im HTML-Format zurückgegeben. Optional.

Anforderungstext

Geben Sie für diese Methode keinen Anforderungstext 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

Das folgende Beispiel ruft das angegebene Ereignis ab. Es gibt Folgendes an:

  • Einen Prefer: outlook.timezone-Header zum Abrufen von Datums- und Uhrzeitwerten in Pacific Normalzeit.
  • Einen $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

Nachfolgend sehen Sie ein Beispiel der 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=",
    "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@a830edad905084922E17020313.onmicrosoft.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@a830edad905084922E17020313.onmicrosoft.com"
            }
        }
    ],
    "hideAttendees": false,
    "organizer":{
        "emailAddress":{
            "name":"Samantha Booth",
            "address":"samanthab@a830edad905084922E17020313.onmicrosoft.com"
        }
    }
}

Beispiel 2: Abrufen der Body-Eigenschaft im Textformat

Anforderung

Das folgende Beispiel zeigt, wie Sie mithilfe einer Prefer: outlook.body-content-type="text" Kopfzeile 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

Nachfolgend sehen Sie ein Beispiel der 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=",
    "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

Hier ist ein Beispiel für die Antwort. Die locations-Eigenschaft enthält Details zu den 3 Orten, für die die Veranstaltung organisiert wird.

Da die Anforderung keine oder Prefer: outlook.body-content-type keine Kopfzeile angibtPrefer: outlook.timezone, werden die Start- und Endeigenschaften in der UTC-Standardzeitzone angezeigt, und der Textkörper weist das Standard-HTML-Format auf.

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=",
  "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.onmicrosoft.com"
      }
    },
    {
      "type":"required",
      "status":{
        "response":"none",
        "time":"0001-01-01T00:00:00Z"
      },
      "emailAddress":{
        "name":"Alex Wilber",
        "address":"AlexW@contoso.onmicrosoft.com"
      }
    }
  ],
  "organizer":{
    "emailAddress":{
      "name":"Adele Vance",
      "address":"AdeleV@contoso.onmicrosoft.com"
    }
  }
}

Beispiel 4: Erweitern eines Serienmasterereignisses

Anforderung

Das folgende Beispiel zeigt das Erweitern eines Serienmasterereignisses einer Terminserie 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 (Betreff, Start, Ende, occurrenceId) zurück. Was Ereignisse in der cancelledOccurrences-Auflistung betrifft, gibt der Vorgang nur die Werte der occurrenceId-Eigenschaft 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=",
  "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"
            }
        }
    ]
}

Siehe auch