List calendarView

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 de l’utilisateur ou d’un autre calendrier de l’utilisateur.

Autorisations

L’une des autorisations suivantes est requise pour appeler cette API. Pour plus d’informations, notamment sur la façon de choisir les autorisations, voir Autorisations.

Type d’autorisation	Autorisations (de celle qui offre le plus de privilèges à celle qui en offre le moins)
Déléguée (compte professionnel ou scolaire)	Calendars.Read, Calendars.ReadWrite
Déléguée (compte Microsoft personnel)	Calendars.Read, Calendars.ReadWrite
Application	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}/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 horaire spécifié dans la valeur et ne sont pas affectées par la valeur de l’en-tête Prefer: outlook.timezone le 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.

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.
Prefer: outlook.body-content-type	string	Format auquel la propriété body est renvoyée. Les valeurs peuvent être au format « texte » ou « html ». Un en-tête Preference-Applied est renvoyé à titre de confirmation si l’en-tête Prefer est spécifié. Si cet en-tête n’est pas spécifié, la propriété body est renvoyée au format HTML. 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.

Exemple

Demande

Voici un exemple de demande.

HTTP

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

C#

// Code snippets are only available for the latest version. Current version is 5.x

var graphClient = new GraphServiceClient(requestAdapter);

var result = await graphClient.Me.CalendarView.GetAsync((requestConfiguration) =>
{
	requestConfiguration.QueryParameters.StartDateTime = "2020-01-01T19:00:00-08:00";
	requestConfiguration.QueryParameters.EndDateTime = "2020-01-02T19:00:00-08:00";
});

Pour plus d’informations sur l’ajout du Kit de développement logiciel (SDK) à votre projet et la création d’un instance authProvider, consultez la documentation du SDK.

Go

import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphconfig "github.com/microsoftgraph/msgraph-sdk-go/users"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)



requestStartDateTime := "2020-01-01T19:00:00-08:00"
requestEndDateTime := "2020-01-02T19:00:00-08:00"

requestParameters := &graphconfig.ItemCalendarViewRequestBuilderGetQueryParameters{
	StartDateTime: &requestStartDateTime,
	EndDateTime: &requestEndDateTime,
}
configuration := &graphconfig.ItemCalendarViewRequestBuilderGetRequestConfiguration{
	QueryParameters: requestParameters,
}

result, err := graphClient.Me().CalendarView().Get(context.Background(), configuration)

Pour plus d’informations sur l’ajout du Kit de développement logiciel (SDK) à votre projet et la création d’un instance authProvider, consultez la documentation du SDK.

Java

GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

LinkedList<Option> requestOptions = new LinkedList<Option>();
requestOptions.add(new QueryOption("startDateTime", "2020-01-01T19:00:00-08:00"));
requestOptions.add(new QueryOption("endDateTime", "2020-01-02T19:00:00-08:00"));

EventCollectionPage calendarView = graphClient.me().calendarView()
	.buildRequest( requestOptions )
	.get();

Pour plus d’informations sur l’ajout du Kit de développement logiciel (SDK) à votre projet et la création d’un instance authProvider, consultez la documentation du SDK.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

let calendarView = await client.api('/me/calendarView?startDateTime=2020-01-01T19:00:00-08:00&endDateTime=2020-01-02T19:00:00-08:00')
	.get();

Pour plus d’informations sur l’ajout du Kit de développement logiciel (SDK) à votre projet et la création d’un instance authProvider, consultez la documentation du SDK.

PHP

<?php

// THIS SNIPPET IS A PREVIEW FOR THE KIOTA BASED SDK. NON-PRODUCTION USE ONLY
$graphServiceClient = new GraphServiceClient($requestAdapter);

$requestConfiguration = new CalendarViewRequestBuilderGetRequestConfiguration();
$queryParameters = CalendarViewRequestBuilderGetRequestConfiguration::createQueryParameters();
$queryParameters->startDateTime = "2020-01-01T19:00:00-08:00";
$queryParameters->endDateTime = "2020-01-02T19:00:00-08:00";
$requestConfiguration->queryParameters = $queryParameters;


$result = $graphServiceClient->me()->calendarView()->get($requestConfiguration);

Pour plus d’informations sur l’ajout du Kit de développement logiciel (SDK) à votre projet et la création d’un instance authProvider, consultez la documentation du SDK.

Réponse

Voici un exemple de 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": "Pacific Standard Time",
      "originalEndTimeZone": "Pacific Standard Time",
      "responseStatus": {
        "response": "accepted",
        "time": "2016-10-19T10:37:00Z"
      },
      "iCalUId": "040000008200E00074C5B7101A82E00800000000D3D70B8A6A17D70100000000000000001000000074665914A06C3F49BB4B7D7EEE4304DA",
      "reminderMinutesBeforeStart": 15,
      "isReminderOn": true
    }
  ]
}