plannerTask： 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/tasks/delta
GET /me/planner/tasks/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 响应正文中返回响应代码和 plannerTask 集合。

示例

示例 1：获取 plannerPlan 中任务的增量

以下示例演示 plannerPlan 中 plannerTask 对象上的增量请求。

请求

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

GET https://graph.microsoft.com/beta/planner/tasks/delta

响应

以下示例显示了相应的响应。

注意：为了提高可读性，可能缩短了此处显示的响应对象。

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

{
  "@odata.context":"https://graph.microsoft.com/beta/$metadata#plannerTask",
  "@odata.deltaLink": "https://graph.microsoft.com/beta/planner/plans('-W4K7hIak0WlAwgJCn1sEWQABgjH')/tasks?%24expand=details&%24deltatoken=0%257eaa6c4c81-656f-40e8-a2c5-60f4116fa9a4",
  "value": [
    {
      "@odata.etag": "W/\"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBASCc=\"",
      "createdBy": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29",
      "createdByApp": "09abbdfd-ed23-44ee-a2d9-a627aa1c90f3",
      "createdByAsIdentitySet": {
        "user": {
          "@odata.type": "#microsoft.taskServices.identity",
          "displayName": null,
          "id": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29"
        },
        "application": {
          "@odata.type": "#microsoft.taskServices.identity",
          "displayName": null,
          "id": "09abbdfd-ed23-44ee-a2d9-a627aa1c90f3"
        }
      },
      "userContentLastModifiedBy": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29",
      "userContentLastModifiedByApp": null,
      "userContentLastModifiedByAsIdentitySet": {
        "user": {
          "@odata.type": "#microsoft.taskServices.identity",
          "displayName": null,
          "id": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29"
        }
      },
      "planId": "-W4K7hIak0WlAwgJCn1sEWQABgjH",
      "bucketId": "iz1mmIxX7EK0Yj7DmRsMs2QAEDXH",
      "title": "Testing",
      "orderHint": "8585371316800245114P\\",
      "assigneePriority": "8585371316123370883",
      "focusDateTime": null,
      "percentComplete": 0,
      "startDateTime": null,
      "createdDateTime": "2022-09-29T18:14:25.6091874Z",
      "userContentLastModifiedDate": "2022-09-29T18:14:33.1404924Z",
      "dueDateTime": null,
      "recurrence": null,
      "hasDescription": false,
      "previewType": "automatic",
      "completedDateTime": null,
      "completedBy": null,
      "completedByApp": null,
      "completedByAsIdentitySet": null,
      "referenceCount": 0,
      "checklistItemCount": 0,
      "activeChecklistItemCount": 0,
      "appliedCategories": {},
      "assignments": {
        "b40c85a0-1a66-4fa3-932f-cc9249ce8c29": {
          "@odata.type": "#microsoft.taskServices.assignment",
          "assignedBy": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29",
          "assignedByAppId": null,
          "assignedByAsIdentitySet": {
            "user": {
              "@odata.type": "#microsoft.taskServices.identity",
              "displayName": null,
              "id": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29"
            }
          },
          "assignedDateTime": "2022-09-29T18:14:33.1404924Z",
          "orderHint": "8585371316723527019PX",
          "createdBy": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29",
          "createdByAppId": null,
          "createdByAsIdentitySet": {
            "user": {
              "@odata.type": "#microsoft.taskServices.identity",
              "displayName": null,
              "id": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29"
            }
          }
        }
      },
      "conversationThreadId": null,
      "priority": 5,
      "creationSource": {
        "publication": null,
        "externalSource": null
      },
      "creationSourceInfo": null,
      "id": "aSOQ0mveu06bTSkfnJQay2QAIn_l",
      "version": "1-Task  @@@@@@@@@@@@@@@H",
      "details@odata.context": "https://tasks.officeppe.com/taskApi/V3.0/$metadata#plans('-W4K7hIak0WlAwgJCn1sEWQABgjH')/tasks('aSOQ0mveu06bTSkfnJQay2QAIn_l')/details/$entity",
      "details": {
        "@odata.etag": "W/\"JzEtVGFza0RldGFpbHMgQEBAQEBAQEBAQEBAQEBARCc=\"",
        "description": "",
        "notes": null,
        "previewType": "automatic",
        "references": {},
        "checklist": {},
        "id": "aSOQ0mveu06bTSkfnJQay2QAIn_l",
        "version": "1-TaskDetails @@@@@@@@@@@@@@@D"
      }
    }
  ]
}

示例 2：获取分配给用户的任务的增量

以下示例显示了对分配给用户的 plannerTask 对象的增量请求。

请求

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

GET https://graph.microsoft.com/beta/me/planner/tasks/delta

响应

以下示例显示了相应的响应。

注意：为了提高可读性，可能缩短了此处显示的响应对象。

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

{
  "@odata.context":"https://graph.microsoft.com/beta/$metadata#plannerTask",
  "@odata.deltaLink": "https://graph.microsoft.com/beta/me/planner/tasks/delta?%24expand=details&%24deltatoken=0%257eaa6c4c81-656f-40e8-a2c5-60f4116fa9a4",
  "value": [
    {
      "@odata.etag": "W/\"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBASCc=\"",
      "createdBy": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29",
      "createdByApp": "09abbdfd-ed23-44ee-a2d9-a627aa1c90f3",
      "createdByAsIdentitySet": {
        "user": {
          "@odata.type": "#microsoft.taskServices.identity",
          "displayName": null,
          "id": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29"
        },
        "application": {
          "@odata.type": "#microsoft.taskServices.identity",
          "displayName": null,
          "id": "09abbdfd-ed23-44ee-a2d9-a627aa1c90f3"
        }
      },
      "userContentLastModifiedBy": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29",
      "userContentLastModifiedByApp": null,
      "userContentLastModifiedByAsIdentitySet": {
        "user": {
          "@odata.type": "#microsoft.taskServices.identity",
          "displayName": null,
          "id": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29"
        }
      },
      "planId": "-W4K7hIak0WlAwgJCn1sEWQABgjH",
      "bucketId": "iz1mmIxX7EK0Yj7DmRsMs2QAEDXH",
      "title": "Testing",
      "orderHint": "8585371316800245114P\\",
      "assigneePriority": "8585371316123370883",
      "focusDateTime": null,
      "percentComplete": 0,
      "startDateTime": null,
      "createdDateTime": "2022-09-29T18:14:25.6091874Z",
      "userContentLastModifiedDate": "2022-09-29T18:14:33.1404924Z",
      "dueDateTime": null,
      "recurrence": null,
      "hasDescription": false,
      "previewType": "automatic",
      "completedDateTime": null,
      "completedBy": null,
      "completedByApp": null,
      "completedByAsIdentitySet": null,
      "referenceCount": 0,
      "checklistItemCount": 0,
      "activeChecklistItemCount": 0,
      "appliedCategories": {},
      "assignments": {
        "b40c85a0-1a66-4fa3-932f-cc9249ce8c29": {
          "@odata.type": "#microsoft.taskServices.assignment",
          "assignedBy": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29",
          "assignedByAppId": null,
          "assignedByAsIdentitySet": {
            "user": {
              "@odata.type": "#microsoft.taskServices.identity",
              "displayName": null,
              "id": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29"
            }
          },
          "assignedDateTime": "2022-09-29T18:14:33.1404924Z",
          "orderHint": "8585371316723527019PX",
          "createdBy": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29",
          "createdByAppId": null,
          "createdByAsIdentitySet": {
            "user": {
              "@odata.type": "#microsoft.taskServices.identity",
              "displayName": null,
              "id": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29"
            }
          }
        }
      },
      "conversationThreadId": null,
      "priority": 5,
      "creationSource": {
        "publication": null,
        "externalSource": null
      },
      "creationSourceInfo": null,
      "id": "aSOQ0mveu06bTSkfnJQay2QAIn_l",
      "version": "1-Task  @@@@@@@@@@@@@@@H",
      "details@odata.context": "https://tasks.officeppe.com/taskApi/V3.0/$metadata#plans('-W4K7hIak0WlAwgJCn1sEWQABgjH')/tasks('aSOQ0mveu06bTSkfnJQay2QAIn_l')/details/$entity",
      "details": {
        "@odata.etag": "W/\"JzEtVGFza0RldGFpbHMgQEBAQEBAQEBAQEBAQEBARCc=\"",
        "description": "",
        "notes": null,
        "previewType": "automatic",
        "references": {},
        "checklist": {},
        "id": "aSOQ0mveu06bTSkfnJQay2QAIn_l",
        "version": "1-TaskDetails @@@@@@@@@@@@@@@D"
      }
    },
  ]
}