命名空间:microsoft.graph
重要
Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
Planner 统一计划图形 API 中的任务。
planId 将任务路由回其父 计划。 与在 Planner 基本计划图形 API 中拆分的 plannerTask/plannerTaskDetails 不同,Planner 统一计划图形 API 中的任务没有单独的详细信息对象 - 说明、备注、清单、分配和链接是任务上直接的属性和子集合。
继承自 plannerDelta。
使用列出的方法创建、读取、更新和删除任务。 可以使用 深度插入在与任务相同的请求中创建受支持的相关对象。 这并不意味着对每个相关类型都支持独立的 CRUD,也不意味着在 PATCH 请求中发送数组将替换集合。
方法
| 方法 | 返回类型 | Description |
|---|---|---|
| List | 任务集合 | 获取任务对象及其属性的列表。 |
| 创建 | task | 创建新的任务对象。 |
| Get | task | 读取 任务 对象的属性和关系。 |
| 更新 | task | 更新任务对象的属性。 |
| 删除 | 无 | 删除任务对象。 |
| 列表清单 | checklistItemV4 集合 | 获取 checklistItemV4 对象及其属性的列表。 |
| 列出 customFieldValues | customFieldValue 集合 | 获取 customFieldValue 对象及其属性的列表。 |
| 列表链接 | contentLink 集合 | 获取 contentLink 对象及其属性的列表。 |
| 列出邮件 | plannerChatMessage 集合 | 获取 plannerChatMessage 对象及其属性的列表。 |
| 列出 userAssignments | userAssignment 集合 | 获取 userAssignment 对象及其属性的列表。 |
属性
| 属性 | 类型 | 说明 |
|---|---|---|
| archivalInfo | plannerArchivalInfo | 有关实体是否存档以及何时存档的服务填充信息。 只读。 |
| bucketId | String | 任务所属的存储桶的 ID。 |
| capabilities | taskCapability | 服务器计算的只读功能标志,指示为实体启用了哪些可选功能。 |
| completedBy | identitySet | 将任务标记为已完成的用户的标识。 只读。 |
| completedDateTime | DateTimeOffset | 任务完成的日期和时间。 只读。 |
| creationInfo | creationInfo | 实体的只读创建元数据。 |
| displayName | String | 任务的标题。 |
| dueDateTime | dateWithOptionalTime | 任务的截止日期和时间(可选)。 |
| extensions | extensionFieldCollection | 在实体上设置的自定义扩展字段值。 支持$select。 |
| finishDateTime | dateWithOptionalTime | 任务完成的日期和时间(可选)。 |
| goalIds | 字符串集合 | 与任务关联的目标的 ID。 |
| hasChat | 布尔值 | 指示任务是否有关联的聊天。 只读。 |
| hasChildren | 布尔值 | 指示任务是否具有子任务。 只读。 |
| id | String | 实体的唯一标识符。 只读。 继承自 实体 |
| isCritical | 布尔值 | 指示任务是否位于根据其依赖项计算出的关键路径上。 只读。 |
| lastModifiedBy | identitySet | 上次修改实体的用户 (或应用程序) 的标识。 只读。 |
| lastModifiedDateTime | DateTimeOffset | 上次修改实体的日期和时间。 该值以 ISO 8601 格式表示,并且始终采用 UTC 时间。 只读。 |
| notes | itemBody | 有关任务的其他详细信息或注释。 |
| parentTaskId | String | 父任务的 ID(如果此任务是子任务)。 |
| percentComplete | Int32 | 任务完成的百分比,范围从 0 到 100。 |
| personalView | taskPersonalView | 任务的每用户个人视图设置,例如“我的一天”成员身份。 |
| planId | String | 包含任务的计划的 ID。 创建后不可变。 |
| planView | taskPlanView | 任务视图设置范围限定于计划,例如应用的类别 ID。 |
| priority | Int32 | 任务优先级。 支持的值范围从 0 (紧急) 到 10 (低) 。 |
| recurrence | plannerTaskRecurrence | 任务的重复周期模式(如果它重复)。 |
| startDateTime | dateWithOptionalTime | 计划任务开始的日期和时间(可选)。 |
| status | plannerTaskStatus | 指示任务的进度。 可能的值包括 notStarted、inProgress、completed、blocked、unknownFutureValue。 |
关系
| 关系 | 类型 | 说明 |
|---|---|---|
| checklist | checklistItemV4 集合 | 任务上的清单项。 可在使用深层插入创建任务时提供。 可为 Null。 |
| customFieldValues | customFieldValue 集合 | 对任务设置的自定义字段值的集合。 只读。 可为 NULL。 |
| links | contentLink 集合 | 附加到任务的内容链接。 可在使用深层插入创建任务时提供。 可为 Null。 |
| messages | plannerChatMessage 集合 | 与任务关联的聊天消息的集合。 只读。 可为 NULL。 |
| userAssignments | userAssignment 集合 | 任务的用户分配。 可在使用深层插入创建任务时提供。 可为 Null。 |
JSON 表示形式
以下 JSON 表示形式显示资源类型。
{
"@odata.type": "#microsoft.graph.task",
"id": "String (identifier)",
"displayName": "String",
"planId": "String",
"bucketId": "String",
"goalIds": [
"String"
],
"status": "String",
"priority": "Int32",
"percentComplete": "Int32",
"startDateTime": {
"@odata.type": "microsoft.graph.dateWithOptionalTime"
},
"dueDateTime": {
"@odata.type": "microsoft.graph.dateWithOptionalTime"
},
"finishDateTime": {
"@odata.type": "microsoft.graph.dateWithOptionalTime"
},
"notes": {
"@odata.type": "microsoft.graph.itemBody"
},
"creationInfo": {
"@odata.type": "microsoft.graph.creationInfo"
},
"lastModifiedBy": {
"@odata.type": "microsoft.graph.identitySet"
},
"lastModifiedDateTime": "String (timestamp)",
"completedBy": {
"@odata.type": "microsoft.graph.identitySet"
},
"completedDateTime": "String (timestamp)",
"recurrence": {
"@odata.type": "microsoft.graph.plannerTaskRecurrence"
},
"archivalInfo": {
"@odata.type": "microsoft.graph.plannerArchivalInfo"
},
"planView": {
"@odata.type": "microsoft.graph.taskPlanView"
},
"personalView": {
"@odata.type": "microsoft.graph.taskPersonalView"
},
"parentTaskId": "String",
"hasChildren": "Boolean",
"isCritical": "Boolean",
"hasChat": "Boolean",
"capabilities": {
"@odata.type": "microsoft.graph.taskCapability"
},
"extensions": {
"@odata.type": "microsoft.graph.extensionFieldCollection"
}
}