Ereignisse auflistenList events

Wichtig

APIs unter der /beta Version in Microsoft Graph können Änderungen unterworfen werden.APIs under the /beta version in Microsoft Graph are subject to change. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt.Use of these APIs in production applications is not supported.

Abrufen einer Liste von event-Objekten aus dem Standardkalender des Benutzers oder einem angegebenen Kalender.Get a list of event objects from the user's default calendar or from a specified calendar. Die Liste enthält einzelne Instanzen von Besprechungen und Serienmaster.The list contains single instance meetings and series masters.

Um erweiterte Ereignisinstanzen abzurufen, können Sie die Kalenderansicht abrufen oder die Instanzen eines Ereignisses abrufen.To get expanded event instances, you can get the calendar view, or get the instances of an event.

Es gibt zwei Szenarien, in denen eine App Ereignisse im Kalender eines anderen Benutzers abrufen kann:There are two scenarios where an app can get events in another user's calendar:

  • Wenn die App Anwendungsberechtigungen besitzt oderIf the app has application permissions, or,
  • Wenn die App die entsprechenden delegierten Berechtigungen von einem Benutzer besitzt und ein anderer Benutzer einen Kalender für diesen Benutzer freigegeben hat oder diesem Benutzer delegierten Zugriff erteilt hat.If the app has the appropriate delegated permissions from one user, and another user has shared a calendar with that user, or, has given delegated access to that user. Hier finden Sie weitere Informationen und ein Beispiel.See details and an example.

Unterstützen verschiedener ZeitzonenSupport various time zones

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.For all GET operations that return events, you can use the Prefer: outlook.timezone header to specify the time zone for the event start and end times in the response.

Mit dem folgenden Prefer: outlook.timezone-Header werden zum Beispiel die Anfangs- und Endzeiten in der Antwort auf EST festgelegt.For example, the following Prefer: outlook.timezone header sets the start and end times in the response to Eastern Standard Time.

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.If the event was created in a different time zone, the start and end times will be adjusted to the time zone specified in that Prefer header. See this list for the supported time zone names. If the Prefer: outlook.timezone header is not specified, the start and end times are returned in UTC.

Sie können die OriginalStartTimeZone- und OriginalEndTimeZone-Eigenschaften für die event-Ressource verwenden, um die beim Erstellen des Ereignisses verwendete Zeitzone abzurufen.You can use the OriginalStartTimeZone and OriginalEndTimeZone properties on the event resource to find out the time zone used when the event was created.

BerechtigungenPermissions

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.One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

BerechtigungstypPermission type Berechtigungen (von der Berechtigung mit den wenigsten Rechten zu der mit den meisten Rechten)Permissions (from least to most privileged)
Delegiert (Geschäfts-, Schul- oder Unikonto)Delegated (work or school account) Calendars.Read, Calendars.ReadWriteCalendars.Read, Calendars.ReadWrite
Delegiert (persönliches Microsoft-Konto)Delegated (personal Microsoft account) Calendars.Read, Calendars.ReadWriteCalendars.Read, Calendars.ReadWrite
AnwendungApplication Calendars.Read, Calendars.ReadWriteCalendars.Read, Calendars.ReadWrite

HTTP-AnforderungHTTP request

GET /me/events
GET /users/{id | userPrincipalName}/events

GET /me/calendar/events
GET /users/{id | userPrincipalName}/calendar/events

GET /me/calendars/{id}/events
GET /users/{id | userPrincipalName}/calendars/{id}/events

GET /me/calendargroup/calendars/{id}/events
GET /users/{id | userPrincipalName}/calendargroup/calendars/{id}/events

GET /me/calendargroups/{id}/calendars/{id}/events
GET /users/{id | userPrincipalName}/calendargroups/{id}/calendars/{id}/events

Optionale AbfrageparameterOptional query parameters

Diese Methode unterstützt die OData-Abfrageparameter zur Anpassung der Antwort.This method supports the OData Query Parameters to help customize the response.

AnforderungsheaderRequest headers

NameName TypType BeschreibungDescription
AuthorizationAuthorization stringstring Bearer {token}. Erforderlich.Bearer {token}. Required.
Prefer: outlook.timezonePrefer: outlook.timezone stringstring Verwenden Sie dies, um die Zeitzone für die Anfangs- und Endzeiten in der Antwort anzugeben.Use this to specify the time zone for start and end times in the response. Wenn nicht angegeben, werden diese Zeitwerte in UTC zurückgegeben.If not specified, those time values are returned in UTC. Optional.Optional.
Besser: outlook.body-content-typePrefer: outlook.body-content-type stringstring Das Format, in der die body-Eigenschaft zurückgegeben werden soll.The format of the body property to be returned in. Werte können „Text“ oder „html“ sein.Values can be "text" or "html". Als Bestätigung wird eine Preference-Applied-Kopfzeile zurückgegeben, wenn diese Prefer-Kopfzeile angegeben ist.A Preference-Applied header is returned as confirmation if this Prefer header is specified. Wenn die Kopfzeile nicht angegeben ist, wird die body-Eigenschaft im HTML-Format zurückgegeben.If the header is not specified, the body property is returned in HTML format. Optional.Optional.

AnforderungstextRequest body

Geben Sie für diese Methode keinen Anforderungstext an.Do not supply a request body for this method.

AntwortResponse

Wenn die Methode erfolgreich verläuft, werden der Antwortcode 200 OK und eine Sammlung von Event-Objekten im Antworttext zurückgegeben.If successful, this method returns a 200 OK response code and collection of event objects in the response body.

BeispielExample

Anforderung 1Request 1

Das erste Beispiel ruft alle Ereignisse des Benutzers ab.The first example gets all the user's events. Es gibt Folgendes an:It specifies the following:

  • Einen Prefer: outlook.timezone-Header zum Abrufen von Datums- und Uhrzeitwerten in Pacific Normalzeit.A Prefer: outlook.timezone header to get date time values returned in Pacific Standard Time.
  • Einen $select-Abfrageparameter zum Zurückgeben bestimmter Eigenschaften. Ohne $select-Parameter werden alle Ereigniseigenschaften zurückgegeben.A $select query parameter to return specific properties. Without a $select parameter, all of the event properties will be returned.

Die Anforderung gibt keinen Prefer: outlook.body-content-type-Header an, um ein bestimmtes Format für den zurückgegebenen Ereignistext anzuzeigen.The request does not specify any Prefer: outlook.body-content-type header to indicate a specific format for the returned event body.

GET https://graph.microsoft.com/beta/me/events?$select=subject,body,bodyPreview,organizer,attendees,start,end,location
Prefer: outlook.timezone="Pacific Standard Time"
Antwort 1Response 1

Nachfolgend sehen Sie ein Beispiel der Antwort.Here is an example of the response. Da kein Prefer: outlook.body-content-type-Header angegeben wurde, wird die body-Eigenschaft im standardmäßigen HTML-Format zurückgegeben.Because no Prefer: outlook.body-content-type header was specified, the body property is returned in the default HTML format.

HTTP/1.1 200 OK
Content-type: application/json
Preference-Applied: outlook.timezone="Pacific Standard Time"
Content-length: 1932

{
    "@odata.context":"https://graph.microsoft.com/beta/$metadata#users('cd209b0b-3f83-4c35-82d2-d88a61820480')/events(subject,body,bodyPreview,organizer,attendees,start,end,location)",
    "value":[
        {
            "@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":"none",
                        "time":"0001-01-01T00:00:00Z"
                    },
                    "emailAddress":{
                        "name":"Dana Swope",
                        "address":"danas@a830edad905084922E17020313.onmicrosoft.com"
                    }
                }
            ],
            "organizer":{
                "emailAddress":{
                    "name":"Samantha Booth",
                    "address":"samanthab@a830edad905084922E17020313.onmicrosoft.com"
                }
            }
        }
    ]
}
Anforderung 2Request 2

Das zweite Beispiel veranschaulicht, wie Sie einen Prefer: outlook.body-content-type="text"-Header verwenden, um die body-Eigenschaft der angegebenen Nachricht im Textformat abzurufen.The second example shows how to use a Prefer: outlook.body-content-type="text" header to get the body property of the specified message in text format.

Die Anforderung verwendet auch einen $select-Abfrageparameter zum Zurückgeben bestimmter Eigenschaften.The request also uses a $select query parameter to return specific properties. Ohne $select-Parameter werden alle Ereigniseigenschaften zurückgegeben.Without a $select parameter, all of the event properties will be returned.

GET https://graph.microsoft.com/beta/me/events?$select=subject,body,bodyPreview
Prefer: outlook.body-content-type="text" 
Antwort 2Response 2

Nachfolgend sehen Sie ein Beispiel der Antwort.Here is an example of the response. Die body-Eigenschaft wird im Textformat zurückgegeben.The body property is returned in text format.

HTTP/1.1 200 OK
Content-type: application/json
Preference-Applied: outlook.body-content-type="text"
Content-length: 640

{
    "@odata.context":"https://graph.microsoft.com/beta/$metadata#users('cd209b0b-3f83-4c35-82d2-d88a61820480')/events(subject,body,bodyPreview)",
    "value":[
        {
            "@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":"text",
                "content":"Dana, this is the time you selected for our orientation. Please bring the notes I sent you.\r\n"
            }
        }
    ]
}