baseTask:delta (已弃用)
命名空间:microsoft.graph
重要
Microsoft Graph /beta
版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
警告
2022 年 5 月 31 日, 基于 baseTask 构建的未完成 API 集已弃用,2022 年 8 月 31 日停止返回数据。 请改用 todoTask API。
获取在特定 baseTaskList 中添加、删除或更新的一组 baseTask 资源。
baseTaskList 中 baseTask 资源的增量函数调用类似于 GET 请求,不同之处在于,通过在其中一个或多个调用中适当应用状态令牌,可以在该 baseTaskList 中查询 baseTask 中的增量更改。 这样,就可以维护和同步用户的 baseTask 资源的本地存储,而无需每次从服务器提取整个集。
权限
为此 API 选择标记为最低特权的权限。 只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考。
权限类型 | 最低特权权限 | 更高特权权限 |
---|---|---|
委派(工作或学校帐户) | Tasks.Read | Tasks.ReadWrite |
委派(个人 Microsoft 帐户) | Tasks.Read | Tasks.ReadWrite |
Application | 不支持。 | 不支持。 |
HTTP 请求
GET /me/tasks/lists/{baseTaskListId}/tasks/delta
GET /users/{userId|userPrincipalName}/tasks/lists/{baseTaskListId}/tasks/delta
查询参数
跟踪 baseTask 集合中的更改会导致一轮或多次 delta 函数调用。 如果要使用任意查询参数($deltatoken
和 $skiptoken
除外),则必须在最初的 delta 请求中指定它。 Microsoft Graph 自动将指定的任意参数编码为响应中提供的 @odata.nextLink
或 @odata.deltaLink
URL 的令牌部分。
只需预先指定所需的任何查询参数一次。
在后续请求中,只需复制并应用 @odata.nextLink
上一响应中的 或 @odata.deltaLink
URL,因为该 URL 已包含编码的所需参数。
查询参数 | 类型 | 说明 |
---|---|---|
$deltatoken | string | 在上一个 delta 函数的 URL 中@odata.deltaLink 返回的状态令牌调用同一 baseTask 集合,指示完成这一轮更改跟踪。 将此令牌包含在对该集合的下一组更改追踪的首次请求中,并保存和应用整个 @odata.deltaLink URL。 |
$skiptoken | string | 在上一个 delta 函数调用的 URL 中@odata.nextLink 返回的状态令牌,指示在同一 baseTask 集合中要跟踪进一步的更改。 |
OData 查询参数
-
baseTask 的增量查询支持
$filter
$top
和$expand
查询参数。 - 不支持
$search
。
请求标头
名称 | 类型 | 说明 |
---|---|---|
Authorization | string | 持有者 {token}。 必填。 详细了解 身份验证和授权。 |
Prefer | string | odata.maxpagesize={x}。 可选。 |
请求正文
请勿提供此方法的请求正文。
响应
如果成功,此函数在 200 OK
响应正文中返回响应代码和 baseTask 集合。
示例
请求
GET https://graph.microsoft.com/beta/me/tasks/lists/AAMkAGVjMzJmMWZjLTgyYjgtNGIyNi1hOGQ0LWRjMjNmMGRmOWNiYQAuAAAAAAAboFsPFj7gQpLAt-6oC2JgAQCQ47jE5P--SoVECqTdM17RAAAB4mDIAAA=/tasks/delta
响应
注意:为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(baseTask)",
"@odata.deltaLink": "https://graph.microsoft.com/beta/me/tasks/lists/AAMkAGVjMzJmMWZjLTgyYjgtNGIyNi1hOGQ0LWRjMjNmMGRmOWNiYQAuAAAAAAAboFsPFj7gQpLAt-6oC2JgAQCQ47jE5P--SoVECqTdM17RAAAB4mDIAAA=/tasks/delta?$deltatoken=AVCnFFj2r7PtnjtkD-g_6dgDSPbEboZhaMYEytpd57pcJMrR9oGkCIjK_dyVkhNB1EQn1zcQt7YZTwCS0V5MNQo6Iy0-T0csAkLZTMlbiII.lVEHqD5xdDrH30csYKP6tEvoYa3WtFhmYLtKBSxCPpQ",
"value": [
{
"@odata.type": "#microsoft.graph.task",
"@odata.etag": "W/\"kOO4xOT//0qFRAqk3TNe0QAAAymRBQ==\"",
"importance": "normal",
"status": "notStarted",
"displayName": "Read documentation",
"createdDateTime": "2021-11-15T13:16:53.0831814Z",
"lastModifiedDateTime": "2021-11-15T13:17:08.8273666Z",
"id": "AAkALgAAAAAAHYQDEapmEc2byACqAC-EWg0AkOO4xOT--0qFRAqk3TNe0QAAAy35RwAA",
"body": {
"content": "",
"contentType": "text"
},
"parentList": {
"id": "AAMkAGVjMzJmMWZjLTgyYjgtNGIyNi1hOGQ0LWRjMjNmMGRmOWNiYQAuAAAAAAAboFsPFj7gQpLAt-6oC2JgAQCQ47jE5P--SoVECqTdM17RAAAB4mDIAAA="
}
}
]
}