List calendarView

  • Article

Espace de noms: microsoft.graph

Obtenir les occurrences, les exceptions et les instances d’événements uniques dans un affichage Calendrier défini par un intervalle de temps, à partir du calendrier par défaut d’un utilisateur (../me/calendarView) ou d’un autre calendrier de l’utilisateur.

Cette API est disponible dans les déploiements de cloud national suivants.

Service global Gouvernement des États-Unis L4 Us Government L5 (DOD) Chine gérée par 21Vianet
✅ ✅ ✅ ✅

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Type d’autorisation Autorisations avec privilèges minimum Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire) Calendars.ReadBasic Calendars.Read, Calendars.ReadWrite
Déléguée (compte Microsoft personnel) Calendars.ReadBasic Calendars.Read, Calendars.ReadWrite
Application Calendars.ReadBasic Calendars.Read, Calendars.ReadWrite

Requête HTTP

Calendrier par défaut d’un utilisateur.

GET /me/calendar/calendarView?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /users/{id | userPrincipalName}/calendar/calendarView?startDateTime={start_datetime}&endDateTime={end_datetime}

Calendrier d’un utilisateur dans le groupe de calendriers par défaut.

GET /me/calendars/{id}/calendarView?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /users/{id | userPrincipalName}/calendars/{id}/calendarView?startDateTime={start_datetime}&endDateTime={end_datetime}

Calendrier d’un utilisateur dans un groupe de calendriers spécifique.

GET /me/calendarGroups/{id}/calendars/{id}/calendarView?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /users/{id | userPrincipalName}/calendarGroups/{id}/calendars/{id}/calendarView?startDateTime={start_datetime}&endDateTime={end_datetime}

Paramètres de requête

Dans l’URL de la requête, indiquez les paramètres obligatoires suivants avec leurs valeurs.

Paramètre Type Description
startDateTime String La date et l’heure de début de la plage horaire, représentées au format ISO 8601. Par exemple, « 2019-11-08T19 :00 :00-08 :00 ».
endDateTime String La date et l’heure de fin de la plage horaire, représentées au format ISO 8601. Par exemple, « 2019-11-08T20 :00 :00-08 :00 ».

Les valeurs de startDateTime et endDateTime sont interprétées à l’aide du décalage de fuseau horaire spécifié dans la valeur et ne sont pas affectées par la valeur de l’en-tête, le Prefer: outlook.timezone cas échéant. Si le décalage de fuseau horaire n’est pas inclus dans la valeur, l'heure est interprétée comme étant UTC.

Cette méthode prend également en charge les paramètres de requête OData pour vous aider à personnaliser la réponse.

Affichage Calendrier avec $top a une valeur minimale de 1 et un maximum de 1 000.

Remarque

Les propriétés createdDateTime et lastModifiedDateTime des objets event ne prennent pas en charge $select. Pour obtenir leurs valeurs, exécutez simplement une requête sur calendarView sans appliquer $select.

En-têtes de demande

Nom Type Description
Autorisation string Porteur {token}. Obligatoire.
Prefer: outlook.timezone string Utilisez cette option pour définir le fuseau horaire pour les heures de début et de fin dans la réponse. Si aucune valeur n’est définie, les heures sont renvoyées au format UTC. Facultatif.

Corps de la demande

N’indiquez pas le corps de la demande pour cette méthode.

Réponse

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.

Si un jeu de résultats s’étend sur plusieurs pages, calendarView renvoie vers une propriété @odata.nextLink dans la réponse contenant une URL vers la page de résultats suivante. Pour plus d’informations, consultez lapagination.

Exemple

Demande

L’exemple suivant illustre une demande.

GET https://graph.microsoft.com/v1.0/me/calendar/calendarView?startDateTime=2017-01-01T19:00:00-08:00&endDateTime=2017-01-07T19:00:00-08:00

Réponse

L’exemple suivant illustre la réponse.

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

HTTP/1.1 200 OK
Content-type: application/json

{
  "value": [
    {
      "originalStartTimeZone": "originalStartTimeZone-value",
      "originalEndTimeZone": "originalEndTimeZone-value",
      "responseStatus": {
        "response": "response-value",
        "time": "datetime-value"
      },
      "iCalUId": "iCalUId-value",
      "reminderMinutesBeforeStart": 99,
      "isReminderOn": true
    }
  ]
}