更新 plannerTaskUpdate plannertask

更新 plannertask 对象的属性。Update the properties of plannertask object.

权限Permissions

要调用此 API,需要以下权限之一。要了解详细信息,包括如何选择权限的信息,请参阅权限One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

权限类型Permission type 权限(从最低特权到最高特权)Permissions (from least to most privileged)
委派(工作或学校帐户)Delegated (work or school account) Group.ReadWrite.AllGroup.ReadWrite.All
委派(个人 Microsoft 帐户)Delegated (personal Microsoft account) 不支持。Not supported.
应用程序Application 不支持。Not supported.

HTTP 请求HTTP request

PATCH /planner/tasks/{id}

可选的请求标头Optional request headers

名称Name 说明Description
AuthorizationAuthorization Bearer {token}。必需。Bearer {token}. Required.
If-MatchIf-Match 要更新的 plannerTask 的上次已知 ETag 值。必需。Last known ETag value for the plannerTask to be updated. Required.

请求正文Request body

在请求正文中,提供应更新的相关字段的值。请求正文中不包括的现有属性将保留其以前的值,或根据对其他属性值的更改重新计算。为了获得最佳性能,不应包括尚未更改的现有值。In the request body, supply the values for relevant fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance you shouldn't include existing values that haven't changed.

属性Property 类型Type 说明Description
appliedCategoriesappliedCategories plannerAppliedCategoriesplannerAppliedCategories 此任务已应用的类别。有关可能的值,请参阅已应用的类别The categories to which the task has been applied. See applied Categories for possible values.
assigneePriorityassigneePriority StringString 用于为列表视图中的此类型项目排序的提示。此格式在使用规划器中的排序提示定义中。Hint used to order items of this type in a list view. The format is defined in Using order hints in Planner.
assignmentsassignments plannerAssignmentsplannerAssignments 分配到任务的用户集合。The set of users the task is assigned to.
bucketIdbucketId StringString 任务所属的存储桶 id。Bucket id to which the task belongs. 存储桶需要位于任务所在的计划中。The bucket needs to be in the plan that the task is in. 长度为 28 个字符,区分大小写。It is 28 characters long and case-sensitive. 格式验证在服务上完成。Format validation is done on the service.
conversationThreadIdconversationThreadId 字符串String 任务对话的线程 id。这是在组中创建的对话线程对象的 id。Thread id of the conversation on the task. This is the id of the conversation thread object created in the group.
dueDateTimedueDateTime DateTimeOffsetDateTimeOffset 任务截止的日期和时间。时间戳类型表示使用 ISO 8601 格式的日期和时间信息,并且始终处于 UTC 时间。例如,2014 年 1 月 1 日午夜 UTC 如下所示:'2014-01-01T00:00:00Z'Date and time at which the task is due. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'
orderHintorderHint 字符串String 用于为列表视图中的此类型项目排序的提示。此格式在使用规划器中的排序提示定义中。Hint used to order items of this type in a list view. The format is defined in Using order hints in Planner.
percentCompletepercentComplete Int32Int32 任务完成的百分比。当设置为 100 时,任务被视为完成。Percentage of task completion. When set to 100, the task is considered completed.
startDateTimestartDateTime DateTimeOffsetDateTimeOffset 任务开始的日期和时间。时间戳类型表示使用 ISO 8601 格式的日期和时间信息,并且始终处于 UTC 时间。例如,2014 年 1 月 1 日午夜 UTC 如下所示:'2014-01-01T00:00:00Z'Date and time at which the task starts. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'
titletitle StringString 任务的标题。Title of the task.

响应Response

如果成功,此方法在响应正文中返回 200 OK 响应代码和更新的 plannerTask 对象。If successful, this method returns a 200 OK response code and updated plannerTask object in the response body.

此方法可以返回任何 HTTP 状态代码。应用应当为此方法处理的最常见的错误为 400、403、404、409 和 412 响应。有关这些错误的详细信息,请参阅常见规划器错误情况This method can return any of the HTTP status codes. The most common errors that apps should handle for this method are the 400, 403, 404, 409, and 412 responses. For more information about these errors, see Common Planner error conditions.

示例Example

请求Request

下面是一个请求示例。Here is an example of the request.

PATCH https://graph.microsoft.com/v1.0/planner/tasks/{task-id}
Content-type: application/json
Content-length: 247
If-Match: W/"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBAWCc="

{
  "assignments": {
    "fbab97d0-4932-4511-b675-204639209557": {
      "@odata.type": "#microsoft.graph.plannerAssignment",
      "orderHint": "N9917 U2883!"
    }
  },
  "appliedCategories": {
    "category3": true,
    "category4": false
  }
}
响应Response

下面是一个响应示例。注意:为了简单起见,可能会将此处所示的响应对象截断。将从实际调用中返回所有属性。Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

HTTP/1.1 200 OK
Content-type: application/json
Content-length: 1423

{
  "createdBy": {
    "user": {
      "id": "6463a5ce-2119-4198-9f2a-628761df4a62"
    }
  },
  "planId": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
  "bucketId": "gcrYAaAkgU2EQUvpkNNXLGQAGTtu",
  "title": "title-value",
  "orderHint": "9223370609546166567W",
  "assigneePriority": "90057581\"",
  "createdDateTime": "2015-03-24T18:36:49.2407981Z",
  "assignments": {
    "6463a5ce-2119-4198-9f2a-628761df4a62": {
      "@odata.type": "#microsoft.graph.plannerAssignment",
      "assignedBy": {
        "user": {
          "id": "6463a5ce-2119-4198-9f2a-628761df4a62"
        }
      },
      "assignedDateTime": "2015-03-25T18:38:21.956Z",
      "orderHint": "N9917"
    },
    "fbab97d0-4932-4511-b675-204639209557": {
      "@odata.type": "#microsoft.graph.plannerAssignment",
      "assignedBy": {
        "user": {
          "id": "1e9955d2-6acd-45bf-86d3-b546fdc795eb"
        }
      },
      "assignedDateTime": "2017-04-24T22:40:44.5665917",
      "orderHint": "RWk1"
    },
    "aaa27244-1db4-476a-a5cb-004607466324": {
      "@odata.type": "#microsoft.graph.plannerAssignment",
      "assignedBy": {
        "user": {
          "id": "6463a5ce-2119-4198-9f2a-628761df4a62"
        }
      },
      "assignedDateTime": "2015-03-25T18:38:21.956Z",
      "orderHint": "U2883"
    }
  },
  "appliedCategories": {
    "category3": true,
    "category5": true,
    "category6": true,
  },
  "id":"01gzSlKkIUSUl6DF_EilrmQAKDhh"
}