命名空间:microsoft.graph
更新 plannerTask 对象的 属性。
权限
要调用此 API,需要以下权限之一。要了解详细信息,包括如何选择权限的信息,请参阅权限。
| 权限类型 | 权限(从最低特权到最高特权) |
|---|---|
| 委派(工作或学校帐户) | Tasks.ReadWrite,Group.ReadWrite.All |
| 委派(个人 Microsoft 帐户) | 不支持。 |
| 应用程序 | 不支持。 |
HTTP 请求
PATCH /planner/tasks/{id}
可选的请求标头
| 名称 | 说明 |
|---|---|
| Authorization | Bearer {token}。必需。 |
| If-Match | 要更新的 plannerTask 的上次已知 ETag 值。必需。 |
请求正文
在请求正文中,提供应更新的相关字段的值。请求正文中不包括的现有属性将保留其以前的值,或根据对其他属性值的更改重新计算。为了获得最佳性能,不应包括尚未更改的现有值。
| 属性 | 类型 | 说明 |
|---|---|---|
| appliedCategories | plannerAppliedCategories | 此任务已应用的类别。有关可能的值,请参阅已应用的类别。 |
| assigneePriority | String | 用于为列表视图中的此类型项目排序的提示。此格式在使用规划器中的排序提示定义中。 |
| assignments | plannerAssignments | 分配到任务的用户集合。 |
| bucketId | String | 任务所属的 Bucket ID。 存储桶需要位于任务所在的计划中。 长度为 28 个字符,区分大小写。 格式验证在服务上完成。 |
| conversationThreadId | 字符串 | 任务对话的线程 id。这是在组中创建的对话线程对象的 id。 |
| dueDateTime | DateTimeOffset | 任务截止的日期和时间。时间戳类型表示使用 ISO 8601 格式的日期和时间信息,并且始终处于 UTC 时间。例如,2014 年 1 月 1 日午夜 UTC 如下所示:2014-01-01T00:00:00Z |
| orderHint | String | 用于为列表视图中的此类型项目排序的提示。此格式在使用规划器中的排序提示定义中。 |
| priority | Int32 | 任务的优先级。 值的有效范围介于两者之间0``10,且递增值的优先级较低 (0优先级10最高,优先级最低) 。 目前,Planner 将值0解释为“紧急”,2``3并4将其解释为“重要”、“7``5``6中等”和8``10``9“低”。1 此外,Planner 为“urgent”、3“important”、“medium”5和9“low”设置值1。 |
| percentComplete | Int32 | 任务完成的百分比。当设置为 100 时,任务被视为完成。 |
| startDateTime | DateTimeOffset | 任务开始的日期和时间。时间戳类型表示使用 ISO 8601 格式的日期和时间信息,并且始终处于 UTC 时间。例如,2014 年 1 月 1 日午夜 UTC 如下所示:2014-01-01T00:00:00Z |
| title | String | 任务的标题。 |
响应
如果成功,此方法将返回 204 No Content 响应和空内容。 如果请求指定 Prefer 具有首选项的标头 return=representation ,则此方法在响应正文中返回 200 OK 响应代码和更新的 plannerTask 对象。
此方法可以返回任何 HTTP 状态代码。应用应当为此方法处理的最常见的错误为 400、403、404、409 和 412 响应。有关这些错误的详细信息,请参阅常见规划器错误情况。
示例
请求
下面是一个请求示例。
HTTP
PATCH https://graph.microsoft.com/v1.0/planner/tasks/{task-id}
Content-type: application/json
Prefer: return=representation
If-Match: W/"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBAWCc="
{
"assignments": {
"fbab97d0-4932-4511-b675-204639209557": {
"@odata.type": "#microsoft.graph.plannerAssignment",
"orderHint": "N9917 U2883!"
}
},
"appliedCategories": {
"category3": true,
"category4": false
}
}
JavaScript
const options = {
authProvider,
};
const client = Client.init(options);
const plannerTask = {
assignments: {
'fbab97d0-4932-4511-b675-204639209557': {
'@odata.type': '#microsoft.graph.plannerAssignment',
orderHint: 'N9917 U2883!'
}
},
appliedCategories: {
category3: true,
category4: false
}
};
await client.api('/planner/tasks/{task-id}')
.update(plannerTask);
有关如何将 SDK 添加 到项目并 创建 authProvider 实例的 详细信息,请参阅 SDK 文档。
C#
GraphServiceClient graphClient = new GraphServiceClient( authProvider );
var plannerTask = new PlannerTask
{
Assignments = new PlannerAssignments
{
AdditionalData = new Dictionary<string, object>()
{
{"fbab97d0-4932-4511-b675-204639209557", "{\"@odata.type\":\"#microsoft.graph.plannerAssignment\",\"orderHint\":\"N9917 U2883!\"}"}
}
},
AppliedCategories = new PlannerAppliedCategories
{
AdditionalData = new Dictionary<string, object>()
{
{"category3", "true"},
{"category4", "false"}
}
}
};
await graphClient.Planner.Tasks["{plannerTask-id}"]
.Request()
.Header("Prefer","return=representation")
.Header("If-Match","W/\"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBAWCc=\"")
.UpdateAsync(plannerTask);
有关如何将 SDK 添加 到项目并 创建 authProvider 实例的 详细信息,请参阅 SDK 文档。
Go
//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClient(requestAdapter)
requestBody := msgraphsdk.NewPlannerTask()
assignments := msgraphsdk.NewPlannerAssignments()
requestBody.SetAssignments(assignments)
assignments.SetAdditionalData(map[string]interface{}{
}
appliedCategories := msgraphsdk.NewPlannerAppliedCategories()
requestBody.SetAppliedCategories(appliedCategories)
appliedCategories.SetAdditionalData(map[string]interface{}{
"category3": true,
"category4": false,
}
headers := map[string]string{
"Prefer": "return=representation"
"If-Match": "W/"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBAWCc=""
}
options := &msgraphsdk.PlannerTaskRequestBuilderPatchRequestConfiguration{
Headers: headers,
}
plannerTaskId := "plannerTask-id"
graphClient.Planner().TasksById(&plannerTaskId).PatchWithRequestConfigurationAndResponseHandler(requestBody, options, nil)
有关如何将 SDK 添加 到项目并 创建 authProvider 实例的 详细信息,请参阅 SDK 文档。
PowerShell
Import-Module Microsoft.Graph.Planner
$params = @{
Assignments = @{
"Fbab97d0-4932-4511-b675-204639209557" = @{
"@odata.type" = "#microsoft.graph.plannerAssignment"
OrderHint = "N9917 U2883!"
}
}
AppliedCategories = @{
Category3 = $true
Category4 = $false
}
}
Update-MgPlannerTask -PlannerTaskId $plannerTaskId -BodyParameter $params
有关如何将 SDK 添加 到项目并 创建 authProvider 实例的 详细信息,请参阅 SDK 文档。
响应
这是一个示例响应。注意:为提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-type: application/json
{
"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",
"priority": 5
}
历史资料。此文对应 2023-02-03 的中文文档快照,适用产品版本和命令行为以原文为准。
来源与署名:Microsoft 和文档贡献者(原始作者元数据 TarkanSevilmis)。固定版本原文。文档采用 CC BY 4.0,示例代码采用 MIT 授权。本站将 Markdown 转为 HTML,规范化链接,移除外部媒体和导航标记。
