列出 calendarView

命名空间:microsoft.graph

从用户的默认日历 (../me/calendarView) 或其他一些日历中,获取由时间范围定义的日历视图中的事件发生次数、异常和单一实例。

此 API 可用于以下国家级云部署

全局服务 美国政府 L4 美国政府 L5 (DOD) 由世纪互联运营的中国

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考

权限类型 最低特权权限 更高特权权限
委派(工作或学校帐户) Calendars.ReadBasic Calendars.Read、Calendars.ReadWrite
委派(个人 Microsoft 帐户) Calendars.ReadBasic Calendars.Read、Calendars.ReadWrite
应用程序 Calendars.ReadBasic Calendars.Read、Calendars.ReadWrite

HTTP 请求

用户的默认 calendar

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

默认 calendarGroup 中的用户 calendar

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”。

endDateTime 的值startDateTime使用值中指定的时区偏移量进行解释,并且不受标头值Prefer: outlook.timezone(如果存在)的影响。 如果值中未包含时区偏移量,则将其解释为 UTC。

此方法还支持一些 OData 查询参数 来帮助自定义响应。

具有 $topCalendarView 的最小值为 1,最大值为 1000。

注意

事件createdDateTimelastModifiedDateTime 属性不支持 $select。 若要获取它们的值,只需在 calendarView 上进行查询,而不应用 $select

请求标头

名称 类型 说明
Authorization string 持有者 {token}。 必填。 详细了解 身份验证和授权
Prefer: outlook.timezone string 此选项可用于指定响应中开始时间和结束时间的时区。 如果未指定,返回的这些时间值采用 UTC 时区。 可选。

请求正文

请勿提供此方法的请求正文。

响应

如果成功,此方法在响应正文中返回 200 OK 响应代码和 event 对象集合。

如果结果集跨多个页面,calendarView 将在响应中返回 @odata.nextLink 属性,其中包含指向下一页结果的 URL。 有关详细信息,请参阅分页

示例

请求

以下示例显示了一个请求。

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