calendarView を一覧表示する

名前空間: 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" です。

endDateTimestartDateTime値は、値で指定されたタイムゾーン オフセットを使用して解釈され、存在する場合はヘッダーの値の影響を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

応答

応答の例を下に示します。

注: ここに示す応答オブジェクトは、読みやすさのために短縮されている場合があります。

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
    }
  ]
}