user: reminderView

命名空间:microsoft.graph 在指定的开始和结束时间内返回用户日历中的事件提醒列表。

此 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 请求

GET /users/{id | userPrincipalName}/reminderView(startDateTime={startDateTime-value},endDateTime={endDateTime-value})

函数参数

在请求 URL 中,提供以下包含值的函数参数。

参数 类型 说明
startDateTime String 事件(已设置提醒)的开始日期和时间。 该值用 ISO 8601 格式表示,例如,“2015-11-08T19:00:00.0000000”。
endDateTime String 事件(已设置提醒)的结束日期和时间。 该值用 ISO 8601 格式表示,例如,“2015-11-08T20:00:00.0000000”。

请求标头

标头
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权
Content-Type application/json
Prefer {Time-zone}。 可选,如果缺省,则采用 UTC。

请求正文

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

响应

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

示例

下面是一个如何调用此 API 的示例。

请求

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

GET https://graph.microsoft.com/v1.0/me/reminderView(startDateTime='2017-06-05T10:00:00.0000000',endDateTime='2017-06-11T11:00:00.0000000')
响应

以下示例显示了相应的响应。 注意:为了提高可读性,可能缩短了此处显示的响应对象。

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

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(microsoft.graph.reminder)",
    "value": [
        {
            "eventId": "AAMkADNsvAAA=",
            "changeKey": "SuFHwDRP1EeXJUopWbSLlgAAmBvk2g==",
            "eventSubject": "Plan summer company picnic",
            "eventWebLink": "https://outlook.office365.com/owa/?itemid=AAMkADNsvAAA%3D&exvsurl=1&path=/calendar/item",
            "eventStartTime": {
                "dateTime": "2017-06-09T18:00:00.0000000",
                "timeZone": "UTC"
            },
            "eventEndTime": {
                "dateTime": "2017-06-09T19:00:00.0000000",
                "timeZone": "UTC"
            },
            "eventLocation": {
                "displayName": "Conf Room 3"
            },
            "reminderFireTime": {
                "dateTime": "2017-06-09T17:45:00.0000000",
                "timeZone": "UTC"
            }
        }
    ]
}