Répertorier des événementsList events

Obtenir la liste des objets événement présents dans la boîte aux lettres de l’utilisateur. La liste contient les instances uniques de réunions et les réunions principales des séries.Get a list of event objects in the user's mailbox. The list contains single instance meetings and series masters.

Pour développer des instances d’événement, vous pouvez obtenir l’affichage du calendrier ou obtenir les instances d’un événement.To get expanded event instances, you can get the calendar view, or get the instances of an event.

Actuellement, cette opération renvoie le corps des événements uniquement au format HTML.Currently, this operation returns event bodies in only HTML format.

Une application peut récupérer les événements du calendrier d’un autre utilisateur dans deux cas :There are two scenarios where an app can get events in another user's calendar:

  • Si l’application dispose des autorisations d’application ; ouIf the app has application permissions, or,
  • Si l’application a les autorisations déléguées adéquates d’un utilisateur et si un autre utilisateur a partagé un calendrier avec cet utilisateur, ou s’il a accordé un accès délégué à cet utilisateur.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. Consultez les détails et un exemple.See details and an example.

Prise en charge de plusieurs fuseaux horairesSupport various time zones

Pour toutes les opérations GET qui renvoient des événements, vous pouvez utiliser l’en-tête Prefer: outlook.timezone pour spécifier le fuseau horaire pour les heures de début et de fin dans la réponse.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.

Par exemple, l’en-tête Prefer: outlook.timezone suivant définit les heures de début et de fin dans la réponse sur l’heure normale de l’Est.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"

Si l’événement a été créé dans un autre fuseau horaire, les heures de début et de fin seront réglées sur le fuseau horaire spécifié dans cet en-tête Prefer. Voir cette liste pour les noms de fuseau horaire pris en charge. Si l’en-tête Prefer: outlook.timezone n’est pas spécifié, les heures de début et de fin sont renvoyées au format UTC.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.

Vous pouvez utiliser les propriétés OriginalStartTimeZone et OriginalEndTimeZone sur la ressource event pour déterminer le fuseau horaire utilisé lors de la création de l’événement.You can use the OriginalStartTimeZone and OriginalEndTimeZone properties on the event resource to find out the time zone used when the event was created.

AutorisationsPermissions

L’une des autorisations suivantes est nécessaire pour appeler cette API. Pour plus d’informations, notamment sur la façon de choisir les autorisations, voir Autorisations.One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Type d’autorisationPermission type Autorisations (de celle qui offre le plus de privilèges à celle qui en offre le moins)Permissions (from least to most privileged)
Déléguée (compte professionnel ou scolaire)Delegated (work or school account) Calendars.Read, Calendars.ReadWriteCalendars.Read, Calendars.ReadWrite
Déléguée (compte Microsoft personnel)Delegated (personal Microsoft account) Calendars.Read, Calendars.ReadWriteCalendars.Read, Calendars.ReadWrite
ApplicationApplication Calendars.Read, Calendars.ReadWriteCalendars.Read, Calendars.ReadWrite

Requête HTTPHTTP 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

Paramètres facultatifs de la requêteOptional query parameters

Cette méthode prend en charge les paramètres de requête OData pour vous aider à personnaliser la réponse.This method supports the OData Query Parameters to help customize the response.

En-têtes de demandeRequest headers

NomName TypeType DescriptionDescription
AutorisationAuthorization stringstring Porteur {token}. Obligatoire.Bearer {token}. Required.
Prefer: outlook.timezonePrefer: outlook.timezone stringstring Utilisez cette option pour définir le fuseau horaire pour les heures de début et de fin dans la réponse.Use this to specify the time zone for start and end times in the response. Si aucune valeur n’est définie, les heures sont renvoyées au format UTC.If not specified, those time values are returned in UTC. Facultatif.Optional.
Prefer: outlook.body-content-typePrefer: outlook.body-content-type stringstring Format auquel la propriété body est renvoyée.The format of the body property to be returned in. Les valeurs peuvent être au format « texte » ou « html ».Values can be "text" or "html". Un en-tête Preference-Applied est renvoyé à titre de confirmation si l’en-tête Prefer est spécifié.A Preference-Applied header is returned as confirmation if this Prefer header is specified. Si cet en-tête n’est pas spécifié, la propriété body est renvoyée au format HTML.If the header is not specified, the body property is returned in HTML format. Facultatif.Optional.

Corps de la demandeRequest body

N’indiquez pas le corps de la demande pour cette méthode.Do not supply a request body for this method.

RéponseResponse

Si elle réussit, cette méthode renvoie un code de réponse 200 OK et une collection d’objets événement dans le corps de la réponse.If successful, this method returns a 200 OK response code and collection of event objects in the response body.

ExempleExample

DemandeRequest

Voici un exemple de demande. Elle indique les éléments suivants :Here is an example of the request. It specifies the following:

  • Un en-tête Prefer: outlook.timezone pour obtenir des valeurs de date/heure renvoyées au format PST.A Prefer: outlook.timezone header to get date time values returned in Pacific Standard Time.
  • Une requête $select avec des paramètres visant à renvoyer des propriétés spécifiques. Sans paramètre $select, toutes les propriétés d’événement sont renvoyées.A $select query parameter to return specific properties. Without a $select parameter, all of the event properties will be returned.
GET https://graph.microsoft.com/v1.0/me/events?$select=subject,body,bodyPreview,organizer,attendees,start,end,location
Prefer: outlook.timezone="Pacific Standard Time"
RéponseResponse

Voici un exemple de réponse. La propriété body est renvoyée au format HTML (par défaut).Here is an example of the response. 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/v1.0/$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"
                }
            }
        }
    ]
}

Exemple de code SDKSDK sample code


GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var events = await graphClient.Me.Events
    .Request()
    .Header("Prefer","outlook.timezone="Pacific Standard Time"")
    .Select( e => new {
             e.Subject,
             e.Body,
             e.BodyPreview,
             e.Organizer,
             e.Attendees,
             e.Start,
             e.End,
             e.Location 
             })
    .GetAsync();

Pour plus d’informations sur la façon d' Ajouter le kit de développement logiciel (SDK) à votre projet et de créer une instance authProvider , consultez la documentation SDK .Read the SDK documentation for details on how to add the SDK to your project and create an authProvider instance.