calendarView を一覧表示する

名前空間: microsoft.graph

ユーザーの既定の予定表またはユーザーが所有する他の予定表から、時間範囲で定義した予定表ビューのイベントの発生、例外、および単一インスタンスを取得します。

アクセス許可

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。

アクセス許可の種類 アクセス許可 (特権の小さいものから大きいものへ)
委任 (職場または学校のアカウント) Calendars.Read、Calendars.ReadWrite
委任 (個人用 Microsoft アカウント) Calendars.Read、Calendars.ReadWrite
アプリケーション Calendars.Read、Calendars.ReadWrite

HTTP 要求

ユーザーの既定の予定表

GET /me/calendar/calendarView?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /users/{id | userPrincipalName}/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 文字列 時間範囲の開始日時は、ISO 8601 形式で表されます。例: "2019-11-08T19:00:00-08:00"。
endDateTime 文字列 時間範囲の終了日時は、ISO 8601 形式で表されます。例: "2019-11-08T20:00:00-08:00"。

startDateTime および endDateTime の値は、値に指定されたタイムゾーン オフセットを使用して解釈され、ヘッダーが存在する場合は、Prefer: outlook.timezone ヘッダーの値に影響されません。 タイムゾーン オフセットが値に含まれていない場合、UTC と解釈されます。

また、このメソッドは応答をカスタマイズするための一部の OData クエリ パラメーターもサポートします。

注意

イベントcreatedDateTime プロパティおよび lastModifiedDateTime プロパティは、$select をサポートしません。 これらの値を取得するには、calendarView にクエリするだけで、$select を適用しません。

要求ヘッダー

名前 説明
Authorization string ベアラー {token}。必須。
優先: outlook.timezone string これを使用して、応答内の開始および終了時刻のタイム ゾーンを指定します。指定しなかった場合、時刻の値は UTC で返されます。オプション。
Prefer: outlook.body-content-type string body プロパティが返されるときの形式です。 値は、"text" または "html" になります。 この Prefer ヘッダーが指定されている場合、Preference-Applied ヘッダーが確認として返されます。 このヘッダーが指定されていない場合は、body プロパティが HTML 形式で返されます。 省略可能。

要求本文

このメソッドには、要求本文を指定しません。

応答

成功した場合、このメソッドは 200 OK 応答コードと、応答本文で event オブジェクトのコレクションを返します。

要求

以下は、要求の例です。

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
応答

以下に応答の例を示します。注: ここに示す応答オブジェクトは、読みやすさのために短縮されている可能性があります。

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