命名空间:microsoft.graph
更新 plannertaskdetails 对象的属性。
权限
要调用此 API,需要以下权限之一。要了解详细信息,包括如何选择权限的信息,请参阅权限。
| 权限类型 | 权限(从最低特权到最高特权) |
|---|---|
| 委派(工作或学校帐户) | Tasks.ReadWrite,Group.ReadWrite.All |
| 委派(个人 Microsoft 帐户) | 不支持。 |
| 应用程序 | 不支持。 |
HTTP 请求
PATCH /planner/tasks/{id}/details
请求标头
| 名称 | 说明 |
|---|---|
| Authorization | Bearer {token}。必需。 |
| If-Match | 要更新的 plannerTaskDetails 的上次已知 ETag 值。必需。 |
请求正文
在请求正文中,提供应更新的相关字段的值。请求正文中不包括的现有属性将保留其以前的值,或根据对其他属性值的更改重新计算。为了获得最佳性能,不应包括尚未更改的现有值。
| 属性 | 类型 | Description |
|---|---|---|
| checklist | plannerChecklistItems | 任务上的检查表项目集合。 |
| 说明 | String | 任务描述 |
| previewType | string | 这将设置显示在任务上的预览类型。 可能的值包括 automatic、noPreview、checklist、description、reference。 设置为显示的 automatic 预览时,由查看任务的应用选择。 |
| references | plannerExternalReferences | 任务上的引用集合。 |
响应
如果成功,此方法将返回 204 No Content 响应和空内容。 如果请求指定具有首选项的标头,则此方法在响应正文中返回 响应代码和更新的 Prefer return=representation 200 OK plannerTaskDetails 对象。
此方法可以返回任何 HTTP 状态代码。应用应当为此方法处理的最常见的错误为 400、403、404、409 和 412 响应。有关这些错误的详细信息,请参阅常见规划器错误情况。
示例
请求
下面是一个请求示例。
HTTP
PATCH https://graph.microsoft.com/v1.0/planner/tasks/{task-id}/details
Content-type: application/json
Prefer: return=representation
If-Match: W/"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBAWCc="
{
"previewType": "noPreview",
"references": {
"http%3A//developer%2Emicrosoft%2Ecom":{
"@odata.type": "microsoft.graph.plannerExternalReference",
"alias": "Documentation",
"previewPriority": " !",
"type": "Other"
},
"https%3A//developer%2Emicrosoft%2Ecom/en-us/graph/graph-explorer":{
"@odata.type": "microsoft.graph.plannerExternalReference",
"previewPriority": " !!",
},
"http%3A//www%2Ebing%2Ecom": null
},
"checklist": {
"95e27074-6c4a-447a-aa24-9d718a0b86fa":{
"@odata.type": "microsoft.graph.plannerChecklistItem",
"title": "Update task details",
"isChecked": true
},
"d280ed1a-9f6b-4f9c-a962-fb4d00dc50ff":{
"@odata.type": "microsoft.graph.plannerChecklistItem",
"isChecked": true,
},
"a93c93c5-10a6-4167-9551-8bafa09967a7": null
}
}
JavaScript
const options = {
authProvider,
};
const client = Client.init(options);
const plannerTaskDetails = {
previewType: 'noPreview',
references: {
'http%3A//developer%2Emicrosoft%2Ecom':{
'@odata.type': 'microsoft.graph.plannerExternalReference',
alias: 'Documentation',
previewPriority: ' !',
type: 'Other'
},
'https%3A//developer%2Emicrosoft%2Ecom/en-us/graph/graph-explorer':{
'@odata.type': 'microsoft.graph.plannerExternalReference',
previewPriority: ' !!',
},
'http%3A//www%2Ebing%2Ecom': null
},
checklist: {
'95e27074-6c4a-447a-aa24-9d718a0b86fa':{
'@odata.type': 'microsoft.graph.plannerChecklistItem',
title: 'Update task details',
isChecked: true
},
'd280ed1a-9f6b-4f9c-a962-fb4d00dc50ff':{
'@odata.type': 'microsoft.graph.plannerChecklistItem',
isChecked: true,
},
'a93c93c5-10a6-4167-9551-8bafa09967a7': null
}
};
await client.api('/planner/tasks/{task-id}/details')
.update(plannerTaskDetails);
有关如何将 SDK 添加 到项目并 创建 authProvider 实例的 详细信息,请参阅 SDK 文档。
C#
GraphServiceClient graphClient = new GraphServiceClient( authProvider );
var plannerTaskDetails = new PlannerTaskDetails
{
PreviewType = PlannerPreviewType.NoPreview,
References = new PlannerExternalReferences
{
AdditionalData = new Dictionary<string, object>()
{
{"http%3A//developer%2Emicrosoft%2Ecom", "{\"@odata.type\":\"microsoft.graph.plannerExternalReference\",\"alias\":\"Documentation\",\"previewPriority\":\" !\",\"type\":\"Other\"}"},
{"https%3A//developer%2Emicrosoft%2Ecom/en-us/graph/graph-explorer", "{\"@odata.type\":\"microsoft.graph.plannerExternalReference\",\"previewPriority\":\" !!\"}"},
{"http%3A//www%2Ebing%2Ecom", "null"}
}
},
Checklist = new PlannerChecklistItems
{
AdditionalData = new Dictionary<string, object>()
{
{"95e27074-6c4a-447a-aa24-9d718a0b86fa", "{\"@odata.type\":\"microsoft.graph.plannerChecklistItem\",\"title\":\"Update task details\",\"isChecked\":true}"},
{"d280ed1a-9f6b-4f9c-a962-fb4d00dc50ff", "{\"@odata.type\":\"microsoft.graph.plannerChecklistItem\",\"isChecked\":true}"},
{"a93c93c5-10a6-4167-9551-8bafa09967a7", "null"}
}
}
};
await graphClient.Planner.Tasks["{plannerTask-id}"].Details
.Request()
.Header("Prefer","return=representation")
.Header("If-Match","W/\"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBAWCc=\"")
.UpdateAsync(plannerTaskDetails);
有关如何将 SDK 添加 到项目并 创建 authProvider 实例的 详细信息,请参阅 SDK 文档。
Go
//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClient(requestAdapter)
requestBody := msgraphsdk.NewPlannerTaskDetails()
previewType := "noPreview"
requestBody.SetPreviewType(&previewType)
references := msgraphsdk.NewPlannerExternalReferences()
requestBody.SetReferences(references)
references.SetAdditionalData(map[string]interface{}{
"http%3A//www%2Ebing%2Ecom": nil,
}
checklist := msgraphsdk.NewPlannerChecklistItems()
requestBody.SetChecklist(checklist)
checklist.SetAdditionalData(map[string]interface{}{
"a93c93c5-10a6-4167-9551-8bafa09967a7": nil,
}
headers := map[string]string{
"Prefer": "return=representation"
"If-Match": "W/"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBAWCc=""
}
options := &msgraphsdk.DetailsRequestBuilderPatchRequestConfiguration{
Headers: headers,
}
plannerTaskId := "plannerTask-id"
graphClient.Planner().TasksById(&plannerTaskId).Details().PatchWithRequestConfigurationAndResponseHandler(requestBody, options, nil)
有关如何将 SDK 添加 到项目并 创建 authProvider 实例的 详细信息,请参阅 SDK 文档。
PowerShell
Import-Module Microsoft.Graph.Planner
$params = @{
PreviewType = "noPreview"
References = @{
"Http%3A//developer%2Emicrosoft%2Ecom" = @{
"@odata.type" = "microsoft.graph.plannerExternalReference"
Alias = "Documentation"
PreviewPriority = " !"
Type = "Other"
}
"Https%3A//developer%2Emicrosoft%2Ecom/en-us/graph/graph-explorer" = @{
"@odata.type" = "microsoft.graph.plannerExternalReference"
PreviewPriority = " !!"
}
"Http%3A//www%2Ebing%2Ecom" = $null
}
Checklist = @{
"95e27074-6c4a-447a-aa24-9d718a0b86fa" = @{
"@odata.type" = "microsoft.graph.plannerChecklistItem"
Title = "Update task details"
IsChecked = $true
}
"D280ed1a-9f6b-4f9c-a962-fb4d00dc50ff" = @{
"@odata.type" = "microsoft.graph.plannerChecklistItem"
IsChecked = $true
}
"A93c93c5-10a6-4167-9551-8bafa09967a7" = $null
}
}
Update-MgPlannerTaskDetail -PlannerTaskId $plannerTaskId -BodyParameter $params
有关如何将 SDK 添加 到项目并 创建 authProvider 实例的 详细信息,请参阅 SDK 文档。
响应
这是一个示例响应。注意:为提高可读性,可能缩短了此处显示的响应对象。
HTTP/1.1 200 OK
Content-type: application/json
{
"description": "Task details properties:\nchecklist:Sub items\nreferences:Related links",
"previewType": "automatic",
"references": {
"https%3A//developer%2Emicrosoft%2Ecom/en-us/graph/graph-explorer": {
"@odata.type": "#microsoft.graph.plannerExternalReference",
"alias": "Graph Explorer",
"type": "Other",
"previewPriority": "8599273",
"lastModifiedBy": {
"user": {
"id": "fbab97d0-4932-4511-b675-204639209557"
}
},
"lastModifiedDateTime": "2017-04-24T22:52:29.814Z"
},
"http%3A//developer%2Emicrosoft%2Ecom": {
"@odata.type": "#microsoft.graph.plannerExternalReference",
"alias": "Documentation",
"type": "Other",
"previewPriority": "90727736",
"lastModifiedBy": {
"user": {
"id": "fbab97d0-4932-4511-b675-204639209557"
}
},
"lastModifiedDateTime": "2017-04-24T22:52:29.814Z"
}
},
"checklist": {
"d280ed1a-9f6b-4f9c-a962-fb4d00dc50ff": {
"@odata.type": "#microsoft.graph.plannerChecklistItem",
"isChecked": true,
"title": "Try reading task details",
"orderHint": "a93c93c5^",
"lastModifiedBy": {
"user": {
"id": "fbab97d0-4932-4511-b675-204639209557"
}
},
"lastModifiedDateTime": "2017-04-24T22:52:29.814Z"
},
"95e27074-6c4a-447a-aa24-9d718a0b86f": {
"@odata.type": "#microsoft.graph.plannerChecklistItem",
"isChecked": true,
"title": "Update task details",
"orderHint": "8587094707721254251P]",
"lastModifiedBy": {
"user": {
"id": "fbab97d0-4932-4511-b675-204639209557"
}
},
"lastModifiedDateTime": "2017-04-24T22:52:29.814Z"
}
},
"id": "gcrYAaAkgU2EQUvpkNNXLGQAGTtu"
}
历史资料。此文对应 2023-02-03 的中文文档快照,适用产品版本和命令行为以原文为准。
来源与署名:Microsoft 和文档贡献者(原始作者元数据 TarkanSevilmis)。固定版本原文。文档采用 CC BY 4.0,示例代码采用 MIT 授权。本站将 Markdown 转为 HTML,规范化链接,移除外部媒体和导航标记。
