List calendarView

Article
06/22/2024

Espace de noms: microsoft.graph

Obtenez les occurrences, exceptions et instances uniques d’événements 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.

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}/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.

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. En savoir plus sur l’authentification et l’autorisation.
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

L’exemple suivant illustre une demande.

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


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

// To initialize your graphClient, see https://zcusa.951200.xyz/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
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 la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).



mgc users calendar-view list --user-id {user-id} --start-date-time "2020-01-01T19:00:00-08:00" --end-date-time "2020-01-02T19:00:00-08:00"

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).



// Code snippets are only available for the latest major version. Current major version is $v1.*

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


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

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

// To initialize your graphClient, see https://zcusa.951200.xyz/en-us/graph/sdks/create-client?from=snippets&tabs=go
calendarView, err := graphClient.Me().CalendarView().Get(context.Background(), configuration)

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

EventCollectionResponse result = graphClient.me().calendarView().get(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 la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).


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 la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Users\Item\CalendarView\CalendarViewRequestBuilderGetRequestConfiguration;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$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)->wait();

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.users.item.calendar_view.calendar_view_request_builder import CalendarViewRequestBuilder
from kiota_abstractions.base_request_configuration import RequestConfiguration
# To initialize your graph_client, see https://zcusa.951200.xyz/en-us/graph/sdks/create-client?from=snippets&tabs=python
query_params = CalendarViewRequestBuilder.CalendarViewRequestBuilderGetQueryParameters(
		start_date_time = "2020-01-01T19:00:00-08:00",
		end_date_time = "2020-01-02T19:00:00-08:00",
)

request_configuration = RequestConfiguration(
query_parameters = query_params,
)

result = await graph_client.me.calendar_view.get(request_configuration = request_configuration)

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

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

Partager via

List calendarView

Autorisations

Requête HTTP

Paramètres de requête

En-têtes de demande

Corps de la demande

Réponse

Exemple

Demande

Réponse

Commentaires

Ressources supplémentaires