更新任务

命名空间:microsoft.graph

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。

更新任务对象的属性。

API 可用性

此 API 可用于以下国家级云部署。

全局服务 美国政府 L4 美国政府 L5 (DOD) 由世纪互联运营的中国
✅ ❌ ❌ ❌

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考。

权限类型 最小特权权限 更高特权权限
委派(工作或学校帐户) 不支持。 不支持。
委派(个人 Microsoft 帐户) 不支持。 不支持。
应用程序 不支持。 不支持。

HTTP 请求

PATCH /planner/tasks_v2/{taskId}

请求标头

名称 说明
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权。
Content-Type application/json. 必需。
If-Match 要更新或删除的资源的完整 ETag。 必填。

使用此资源的最新读取返回的完整 ETag 作为 If-Match 值。 不要自行构造或比较 ETag。 缺少、无效或不再可用的 ETag 结果为 412 Precondition Failed. 冲突的更改可能会导致 409 Conflict;再次读取资源并在重试之前协调更改。 当服务可以合并非冲突更改时,较旧的 ETag 不一定会失败。

请求正文

在请求正文中, 仅 提供要更新的属性的值。 请求正文中未包含的现有属性会保留其以前的值,或者会根据其他属性值的更改重新计算。

下表指定可更新的属性。

属性 类型 说明
displayName String 任务的标题。
bucketId String 任务所属的存储桶的 ID。
goalIds 字符串集合 与任务关联的目标的 ID。
status plannerTaskStatus 指示任务的进度。 可能的值包括 notStarted、inProgress、completed、blocked、unknownFutureValue。
priority Int32 任务优先级。 支持的值范围从 0 (紧急) 到 10 (低) 。
percentComplete Int32 任务完成的百分比,范围从 0 到 100。
startDateTime dateWithOptionalTime 计划任务开始的日期和时间(可选)。
dueDateTime dateWithOptionalTime 任务的截止日期和时间(可选)。
finishDateTime dateWithOptionalTime 任务完成的日期和时间(可选)。
notes itemBody 有关任务的其他详细信息或注释。
recurrence plannerTaskRecurrence 任务的重复周期模式(如果它重复)。
planView taskPlanView 任务视图设置范围限定于计划,例如应用的类别 ID。
personalView taskPersonalView 任务的每用户个人视图设置,例如“我的一天”成员身份。
parentTaskId String 父任务的 ID(如果此任务是子任务)。
extensions extensionFieldCollection 在实体上设置的自定义扩展字段值。 支持$select。

仅发送要更改的属性。 不要从 GET 响应中包含不可变属性或服务填充的属性。

对于 startDateTime、 dueDateTime 和 finishDateTime,仅指定 日期。 time、timeZone 和 isTimeSpecified 组件是不可写入的。

parentTaskId 和 recurrence 等属性取决于计划支持的功能。 不要将此表视为每个计划都可用的每个功能的保证。

响应

如果成功,此方法将在响应正文中返回 200 OK 响应代码和更新的 任务 对象。

示例

请求

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

PATCH https://graph.microsoft.com/beta/planner/tasks_v2/{taskId}
If-Match: {etag}
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.task",
  "percentComplete": 25
}

响应

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

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

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

{
  "@odata.type": "#microsoft.graph.task",
  "id": "86d64a5b-109d-39c9-dd43-d7fffb6a1670",
  "displayName": "Product launch",
  "planId": "b3d9f9a2-3e14-4a4b-9b2b-6b6d9e6a2f31",
  "bucketId": "9c9c7a3d-5b7f-45e9-9df9-9f8b0f7edc9a"
}