命名空间:microsoft.graph
获取一组在 微软待办 中添加、删除或删除的 todoTaskList 资源。
todoTaskList 的 增量 函数调用类似于 GET 请求,只是通过在其中一个或多个调用中适当应用 状态令牌,可以查询 todoTaskList 中的增量更改。 这样便可以维护和同步用户 todoTaskList 的本地存储,而无需每次从服务器提取所有 todoTaskList 。
Permissions
要调用此 API,需要以下权限之一。要了解详细信息,包括如何选择权限的信息,请参阅权限。
| 权限类型 | 权限(从最低特权到最高特权) |
|---|---|
| 委派(工作或学校帐户) | Tasks.ReadWrite |
| 委派(个人 Microsoft 帐户) | Tasks.ReadWrite |
| 应用 | 不支持 |
HTTP 请求
GET /me/todo/lists/delta
GET /users/{id|userPrincipalName}/todo/lists/delta
查询参数
跟踪 todoTaskList 资源中的更改会产生一轮或多次 增量 函数调用。 如果要使用任意查询参数($deltatoken 和 $skiptoken 除外),则必须在最初的 delta 请求中指定它。 Microsoft Graph 自动将指定的任意参数编码为响应中提供的 @odata.nextLink 或 @odata.deltaLink URL 的令牌部分。 只需预先指定所需的任何查询参数一次。 在后续请求中@odata.nextLink``@odata.deltaLink,只需复制并应用上一个响应中的 URL,因为该 URL 已包含编码的所需参数。
| 查询参数 | 类型 | 说明 |
|---|---|---|
| $deltatoken | string | 在上一个 增量 函数的 URL 中@odata.deltaLink返回的 状态令牌调用同一 todoTaskList 集合,指示完成该轮更改跟踪。 将此令牌包含在对该集合的下一组更改追踪的首次请求中,并保存和应用整个 @odata.deltaLink URL。 |
| $skiptoken | string | 在上一个 增量 函数调用的 URL 中@odata.nextLink返回的 状态令牌,指示要在同一 todoTaskList 集合中跟踪进一步的更改。 |
OData 查询参数
像在任何 GET 请求中一样,你可以使用 $select 查询参数以仅指定获取最佳性能所需的属性。始终返回 id 属性。
请求标头
| 名称 | 类型 | 说明 |
|---|---|---|
| Authorization | string | Bearer {token}。必需。 |
| Content-Type | string | application/json. Required. |
| Prefer | string | odata.maxpagesize={x}。可选。 |
响应
如果成功,此方法在响应正文中返回 200 OK 响应代码和 todoTaskList 集合对象。
示例
请求
以下示例演示如何进行初始 增量 函数调用,并将响应正文中 todoTaskList 的最大数目限制为 2。
若 要跟踪 todoTaskList 中的更改,需要使用适当的状态令牌进行一个或多个 增量 函数调用,以获取自上次增量查询以来的增量更改集。
在列表中跟踪 todoTaskList 和跟踪 todoTask 资源之间的主要区别是增量查询请求 URL 和返回 todoTaskList 而不是 todoTask 集合的查询响应。
GET https://graph.microsoft.com/v1.0/me/todo/lists/delta
Prefer: odata.maxpagesize=2
响应
如果请求成功,响应将包含一个状态令牌,其为 skipToken
(位于 @odata.nextLink 响应头中)或 deltaToken(位于 @odata.deltaLink 响应头中)。它们分别指示应继续此组调用还是已获取该组的所有更改。
以下响应显示了 @odata.nextLink 响应头中的 skipToken。
注意:为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.deltaLink":"https://graph.microsoft.com/v1.0/me/todo/lists/delta?$skiptoken=ldfdgdgfoT5csv4k99nvQqyku0jaGqMhc6XyFff5qQTQ7RJOr",
"value": [
{
"@odata.etag":"W/\"4rfRVIPi9EqXgDbc8U7HGwADLLQ93w==\"",
"displayName":"List1",
"isOwner":true,
"isShared":false,
"wellknownListName":"none",
"id":"AQMkADMwNTcyZjQzLTdkMGItNDdjMy04ZTYwLTJhYmUzNGI5ZD"
}
]
}
另请参阅
历史资料。此文对应 2023-02-03 的中文文档快照,适用产品版本和命令行为以原文为准。
来源与署名:Microsoft 和文档贡献者(原始作者元数据 avijityadav)。固定版本原文。文档采用 CC BY 4.0,示例代码采用 MIT 授权。本站将 Markdown 转为 HTML,规范化链接,移除外部媒体和导航标记。
