名前空間: microsoft.graph
ユーザーの既定の予定表(../me/calendarView)
またはユーザーが所有する他の予定表を元に、時間範囲で定義した予定表ビューから、イベントの発生、例外、および単一のインスタンスを取得します。
この API は、次の国内クラウド展開で使用できます。
グローバル サービス |
米国政府機関 L4 |
米国政府機関 L5 (DOD) |
21Vianet が運営する中国 |
✅ |
✅ |
✅ |
✅ |
アクセス許可
この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。
アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、「アクセス許可のリファレンス」を参照してください。
アクセス許可の種類 |
最小特権アクセス許可 |
より高い特権のアクセス許可 |
委任 (職場または学校のアカウント) |
Calendars.ReadBasic |
Calendars.Read、Calendars.ReadWrite |
委任 (個人用 Microsoft アカウント) |
Calendars.ReadBasic |
Calendars.Read、Calendars.ReadWrite |
アプリケーション |
Calendars.ReadBasic |
Calendars.Read、Calendars.ReadWrite |
HTTP 要求
ユーザーの既定の予定表。
GET /me/calendar/calendarView?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /users/{id | userPrincipalName}/calendar/calendarView?startDateTime={start_datetime}&endDateTime={end_datetime}
既定の calendarGroup のユーザーの予定表。
GET /me/calendars/{id}/calendarView?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /users/{id | userPrincipalName}/calendars/{id}/calendarView?startDateTime={start_datetime}&endDateTime={end_datetime}
特定の calendarGroup のユーザーの予定表。
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}
クエリ パラメーター
要求 URL に、次の必須のクエリ パラメーターを値で指定します。
パラメーター |
種類 |
説明 |
startDateTime |
String |
時間範囲の開始日時は、ISO 8601 形式で表されます。 たとえば、"2019-11-08T19:00:00-08:00" です。 |
endDateTime |
String |
時間範囲の終了日時は、ISO 8601 形式で表されます。 たとえば、"2019-11-08T20:00:00-08:00" です。 |
startDateTime
とendDateTime
の値は、値で指定されたタイム ゾーン オフセットを使用して解釈され、存在する場合、Prefer: outlook.timezone
ヘッダーの値の影響を受けません。 タイムゾーン オフセットが値に含まれていない場合、UTC と解釈されます。
また、このメソッドは応答をカスタマイズするための一部の OData クエリ パラメーターもサポートします。
$top
を使用する CalendarView の最小値は 1、最大値は 1000 です。
注:
イベントの createdDateTime プロパティおよび lastModifiedDateTime プロパティは、$select
をサポートしません。 これらの値を取得するには、calendarView にクエリするだけで、$select
を適用しません。
名前 |
種類 |
説明 |
Authorization |
string |
ベアラー {token}。 必須です。
認証と認可についての詳細をご覧ください。 |
優先: outlook.timezone |
string |
これを使用して、応答内の開始および終了時刻のタイム ゾーンを指定します。 指定しない場合、これらの時刻値は UTC で返されます。 省略可能。 |
要求本文
このメソッドには、要求本文を指定しません。
応答
成功した場合、このメソッドは 200 OK
応答コードと、応答本文で event オブジェクトのコレクションを返します。
要求セットが複数ページにまたがる場合、calendarView は、結果の次ページへの URL を格納する @odata.nextLink プロパティを応答で返します。 詳細については、ページングを参照してください。
例
要求
次の例は要求を示しています。
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
// Code snippets are only available for the latest version. Current version is 5.x
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Me.Calendar.CalendarView.GetAsync((requestConfiguration) =>
{
requestConfiguration.QueryParameters.StartDateTime = "2017-01-01T19:00:00-08:00";
requestConfiguration.QueryParameters.EndDateTime = "2017-01-07T19:00:00-08:00";
});
プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。
mgc users calendar calendar-view get --user-id {user-id} --start-date-time "2017-01-01T19:00:00-08:00" --end-date-time "2017-01-07T19:00:00-08:00"
プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、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 := "2017-01-01T19:00:00-08:00"
requestEndDateTime := "2017-01-07T19:00:00-08:00"
requestParameters := &graphusers.CalendarCalendarViewRequestBuilderGetQueryParameters{
StartDateTime: &requestStartDateTime,
EndDateTime: &requestEndDateTime,
}
configuration := &graphusers.CalendarCalendarViewRequestBuilderGetRequestConfiguration{
QueryParameters: requestParameters,
}
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
calendarView, err := graphClient.Me().Calendar().CalendarView().Get(context.Background(), configuration)
プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
EventCollectionResponse result = graphClient.me().calendar().calendarView().get(requestConfiguration -> {
requestConfiguration.queryParameters.startDateTime = "2017-01-01T19:00:00-08:00";
requestConfiguration.queryParameters.endDateTime = "2017-01-07T19:00:00-08:00";
});
プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。
const options = {
authProvider,
};
const client = Client.init(options);
let calendarView = await client.api('/me/calendar/calendarView?startDateTime=2017-01-01T19:00:00-08:00&endDateTime=2017-01-07T19:00:00-08:00')
.get();
プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Users\Item\Calendar\CalendarView\CalendarViewRequestBuilderGetRequestConfiguration;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestConfiguration = new CalendarViewRequestBuilderGetRequestConfiguration();
$queryParameters = CalendarViewRequestBuilderGetRequestConfiguration::createQueryParameters();
$queryParameters->startDateTime = "2017-01-01T19:00:00-08:00";
$queryParameters->endDateTime = "2017-01-07T19:00:00-08:00";
$requestConfiguration->queryParameters = $queryParameters;
$result = $graphServiceClient->me()->calendar()->calendarView()->get($requestConfiguration)->wait();
プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。
Import-Module Microsoft.Graph.Calendar
# A UPN can also be used as -UserId.
Get-MgUserCalendarView -UserId $userId -Startdatetime "2017-01-01T19:00:00-08:00" -Enddatetime "2017-01-07T19:00:00-08:00"
プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、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.calendar_view.calendar_view_request_builder import CalendarViewRequestBuilder
from kiota_abstractions.base_request_configuration import RequestConfiguration
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
query_params = CalendarViewRequestBuilder.CalendarViewRequestBuilderGetQueryParameters(
start_date_time = "2017-01-01T19:00:00-08:00",
end_date_time = "2017-01-07T19:00:00-08:00",
)
request_configuration = RequestConfiguration(
query_parameters = query_params,
)
result = await graph_client.me.calendar.calendar_view.get(request_configuration = request_configuration)
プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。
応答
次の例は応答を示しています。
注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。
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
}
]
}