calendarView を一覧表示するList calendarView

名前空間: microsoft.graphNamespace: microsoft.graph

ユーザーの既定の予定表またはユーザーが所有する他の予定表から、時間範囲で定義した予定表ビューのイベントの発生、例外、および単一インスタンスを取得します。Get the occurrences, exceptions, and single instances of events in a calendar view defined by a time range, from the user's default calendar, or from some other calendar of the user's.

アクセス許可Permissions

この API を呼び出すには、次のいずれかのアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

アクセス許可の種類Permission type アクセス許可 (特権の小さいものから大きいものへ)Permissions (from least to most privileged)
委任 (職場または学校のアカウント)Delegated (work or school account) Calendars.Read、Calendars.ReadWriteCalendars.Read, Calendars.ReadWrite
委任 (個人用 Microsoft アカウント)Delegated (personal Microsoft account) Calendars.Read、Calendars.ReadWriteCalendars.Read, Calendars.ReadWrite
アプリケーションApplication Calendars.Read、Calendars.ReadWriteCalendars.Read, Calendars.ReadWrite

HTTP 要求HTTP request

ユーザーの既定の予定表A user's default calendar.

GET /me/calendar/calendarView?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /users/{id | userPrincipalName}/calendarView?startDateTime={start_datetime}&endDateTime={end_datetime}

既定の calendarGroup のユーザーの予定表A user's calendar in the default 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}

GET /me/calendarGroup/calendars/{id}/calendarView?startDateTime={start_datetime}&endDateTime={end_datetime}
GET /users/{id | userPrincipalName}/calendarGroup/calendars/{id}/calendarView?startDateTime={start_datetime}&endDateTime={end_datetime}

特定の calendarGroup のユーザーの予定表A user's calendar in a specific 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}

クエリ パラメーターQuery parameters

要求 URL に、次の必須のクエリ パラメーターを値で指定します。In the request URL, provide the following required query parameters with values.

パラメーターParameter 種類Type 説明Description
startDateTimestartDateTime 文字列String 時間範囲の開始日時は、ISO 8601 形式で表されます。例: "2019-11-08T19:00:00-08:00"。The start date and time of the time range, represented in ISO 8601 format. For example, "2019-11-08T19:00:00-08:00".
endDateTimeendDateTime 文字列String 時間範囲の終了日時は、ISO 8601 形式で表されます。例: "2019-11-08T20:00:00-08:00"。The end date and time of the time range, represented in ISO 8601 format. For example, "2019-11-08T20:00:00-08:00".

startDateTime および endDateTime の値は、値に指定されたタイムゾーン オフセットを使用して解釈され、ヘッダーが存在する場合は、Prefer: outlook.timezone ヘッダーの値に影響されません。The values of startDateTime and endDateTime are interpreted using the timezone offset specified in the value and are not impacted by the value of the Prefer: outlook.timezone header if present. タイムゾーン オフセットが値に含まれていない場合、UTC と解釈されます。If no timezone offset is included in the value, it is interpreted as UTC.

また、このメソッドは応答をカスタマイズするための一部の OData クエリ パラメーターもサポートします。This method also supports some of the OData Query Parameters to help customize the response.

注意

イベントcreatedDateTime プロパティおよび lastModifiedDateTime プロパティは、$select をサポートしません。The createdDateTime and lastModifiedDateTime properties of event do not support $select. これらの値を取得するには、calendarView にクエリするだけで、$select を適用しません。To get their values, simply query on calendarView without applying $select.

要求ヘッダーRequest headers

名前Name 種類Type 説明Description
AuthorizationAuthorization stringstring ベアラー {トークン}。必須。Bearer {token}. Required.
優先: outlook.timezonePrefer: outlook.timezone stringstring これを使用して、応答内の開始および終了時刻のタイム ゾーンを指定します。Use this to specify the time zone for start and end times in the response. 指定しない場合、これらの時刻値は UTC で返されます。If not specified, those time values are returned in UTC. 省略可能。Optional.
Prefer: outlook.body-content-typePrefer: outlook.body-content-type stringstring body プロパティが返されるときの形式です。The format of the body property to be returned in. 値は、"text" または "html" になります。Values can be "text" or "html". この Prefer ヘッダーが指定されている場合、Preference-Applied ヘッダーが確認として返されます。A Preference-Applied header is returned as confirmation if this Prefer header is specified. このヘッダーが指定されていない場合は、body プロパティが HTML 形式で返されます。If the header is not specified, the body property is returned in HTML format. 省略可能。Optional.

要求本文Request body

このメソッドには、要求本文を指定しません。Do not supply a request body for this method.

応答Response

成功した場合、このメソッドは 200 OK 応答コードと、応答本文で event オブジェクトのコレクションを返します。If successful, this method returns a 200 OK response code and collection of event objects in the response body.

Example

要求Request

以下は、要求の例です。Here is an example of the request.

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

以下は、応答の例です。注:簡潔にするために、ここに示す応答オブジェクトは切り詰められている場合があります。すべてのプロパティは実際の呼び出しから返されます。Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

HTTP/1.1 200 OK
Content-type: application/json
Content-length: 354

{
  "value": [
    {
      "originalStartTimeZone": "originalStartTimeZone-value",
      "originalEndTimeZone": "originalEndTimeZone-value",
      "responseStatus": {
        "response": "",
        "time": "datetime-value"
      },
      "iCalUId": "iCalUId-value",
      "reminderMinutesBeforeStart": 99,
      "isReminderOn": true
    }
  ]
}