plannerBucket: delta
命名空间:microsoft.graph
重要
Microsoft Graph /beta
版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
获取Planner计划中新建、更新或删除的存储桶,而无需执行整个资源集合的完整读取。 有关详细信息,请参阅 使用增量查询跟踪 Microsoft Graph 数据中的更改。
此 API 可用于以下国家级云部署。
全局服务 | 美国政府 L4 | 美国政府 L5 (DOD) | 由世纪互联运营的中国 |
---|---|---|---|
✅ | ✅ | ✅ | ❌ |
权限
为此 API 选择标记为最低特权的权限。 只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考。
权限类型 | 最低特权权限 | 更高特权权限 |
---|---|---|
委派(工作或学校帐户) | Tasks.Read | 不可用。 |
委派(个人 Microsoft 帐户) | 不支持。 | 不支持。 |
应用程序 | Tasks.Read.All | 不可用。 |
HTTP 请求
GET /planner/plans/{plan-id}/buckets/delta
查询参数
跟踪更改会导致一轮或多次 增量 函数调用。 如果要使用任意查询参数($deltaToken
和 $skipToken
除外),则必须在最初的 delta 请求中指定它。 Microsoft Graph 自动将指定的任意参数编码为响应中提供的 @odata.nextLink
或 @odata.deltaLink
URL 的令牌部分。 只需预先指定任何查询参数一次。 在后续请求中,复制并应用上一 @odata.nextLink
响应中的 或 @odata.deltaLink
URL。 该 URL 已包含编码参数。
查询参数 | 类型 | 说明 |
---|---|---|
$deltaToken | string | 在上一个 delta 函数的 URL 中@odata.deltaLink 返回的状态令牌调用同一资源集合,指示完成这一轮更改跟踪。 保存并应用整个 @odata.deltaLink URL,包括该集合的下一轮更改跟踪的第一个请求中的此令牌。 |
$skipToken | string | 在上一个 delta 函数调用的 URL 中@odata.nextLink 返回的状态令牌,指示要在同一资源集合中跟踪进一步的更改。 |
请求标头
名称 | 说明 |
---|---|
Authorization | 持有者 {token}。 必填。 详细了解 身份验证和授权。 |
Content-Type | application/json |
请求正文
请勿提供此方法的请求正文。
响应
如果成功,此函数在 200 OK
响应正文中返回响应代码和 plannerBucket 集合。 响应还包括 或 @odata.nextLink
@odata.deltaLink
URL。
@odata.nextLink
响应对象中的 URL 指示会话中要检索的其他数据页。 应用程序继续使用@odata.nextLink
URL 发出请求,直到响应中包含@odata.deltaLink
URL。@odata.deltaLink
响应对象中的 URL 指示不再返回有关资源现有状态的数据。 持久保存并使用@odata.deltaLink
URL 来了解将来对资源的更改。
有关详细信息,请参阅 使用增量查询跟踪 Microsoft Graph 数据中的更改。 有关演示如何跟踪用户更改的示例,请参阅 获取用户的增量更改。
示例
以下示例演示 plannerPlan 包含的 plannerBucket 对象上的 delta 请求。
请求
以下示例显示了一个请求。
GET https://graph.microsoft.com/beta/planner/plans/-W4K7hIak0WlAwgJCn1sEWQABgjH/buckets/delta
响应
以下示例显示了相应的响应。
注意:为了提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context":"https://graph.microsoft.com/beta/$metadata#plannerBucket",
"@odata.deltaLink": "https://graph.microsoft.com/beta/planner/plans('-W4K7hIak0WlAwgJCn1sEWQABgjH')/buckets?deltatoken=0%257eaa6c4c81-656f-40e8-a2c5-60f4116fa9a4",
"value": [
{
"@odata.etag": "W/\"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBASCc=\"",
"id": "iz1mmIxX7EK0Yj7DmRsMs2QAEDXH",
"name": "This is a bucket",
"planId": "-W4K7hIak0WlAwgJCn1sEWQABgjH",
"orderHint": "8585371316800245114P\\"
}
]
}