plannerTask 资源类型
命名空间：microsoft.graph
重要
Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用，请使用 版本 选择器。
表示 Microsoft 365 中的规划器任务。 规划器任务包含在 计划中 ，可以分配给计划中的 存储桶 。 每个任务对象都有一个 details 对象，该对象可以包含有关该任务的详细信息。 有关组、计划和任务之间的关系的详细信息，请参阅 使用规划器 REST API。
方法
| 方法 | 返回类型 | 说明 |
|---|---|---|
| 创建 | plannerTask | 创建 plannerTask 对象。 |
| Get | plannerTask | 读取 plannerTask 对象的属性和关系。 |
| 更新 | plannerTask | 更新 plannerTask 对象。 |
| 删除 | None | 删除 plannerTask 对象。 |
| 获取增量 | plannerTask 集合 | 获取 plannerPlan 中新创建、更新或删除的 plannerTask 对象或分配给登录用户，而无需执行整个资源集合的完整读取。 |
属性
| 属性 | 类型 | 说明 |
|---|---|---|
| activeChecklistItemCount | Int32 | 值设置为 false的清单项数，表示不完整的项目。 |
| appliedCategories | plannerAppliedCategories | 任务应用到的类别。 有关可能的值，请参阅 plannerAppliedCategories 资源类型 。 |
| archivalInfo | plannerArchivalInfo | 此为只读属性。 可为 NULL。 包含有关谁存档或取消存档任务以及原因的信息。 |
| assigneePriority | String | 用于在列表视图中对此类型的项进行排序的提示。 有关详细信息，请参阅 在 planner 中使用订单提示。 |
| assignments | plannerAssignments | 被分配任务的接受者集合。 |
| bucketId | String | 此任务所属的存储桶 ID。 存储桶需要与任务位于同一计划中。 bucketId 属性的值长度为 28 个字符，区分大小写。 格式验证在服务上完成。 |
| checklistItemCount | Int32 | 任务上存在的清单项数。 |
| completedBy | identitySet | 完成任务的用户的标识。 |
| completedDateTime | DateTimeOffset | 只读。 任务的 设置为 '100'的日期和时间'percentComplete'。 时间戳类型表示采用 ISO 8601 格式的日期和时间信息，始终采用 UTC 时区。 例如，2014 年 1 月 1 日午夜 UTC 为 2014-01-01T00:00:00Z |
| conversationThreadId | 字符串 | 任务上的会话的线程 ID。 这是组中创建的会话线程对象的 ID。 |
| createdBy | identitySet | 创建任务的用户的标识。 |
| createdDateTime | DateTimeOffset | 只读。 任务的创建日期和时间。 时间戳类型表示采用 ISO 8601 格式的日期和时间信息，始终采用 UTC 时区。 例如，2014 年 1 月 1 日午夜 UTC 为 2014-01-01T00:00:00Z |
| creationSource | plannerTaskCreation | 有关任务源的信息。 |
| dueDateTime | DateTimeOffset | 任务的截止日期和时间。 时间戳类型使用 ISO 8601 格式表示日期和时间信息，并且始终采用 UTC 时间。 例如，2014 年 1 月 1 日午夜 UTC 为 2014-01-01T00:00:00Z |
| hasDescription | Boolean | 此为只读属性。 如果任务的详细信息对象具有非空说明，则此值 true 为 。 否则为false 。 |
| id | String | 只读。 任务的唯一标识符。 此属性的值长度为 28 个字符，区分大小写。 格式验证在服务上完成。 |
| isArchived | Boolean | 此为只读属性。 如果设置为 true，则会存档任务。 存档的任务是只读的。 |
| isOnMyDay | 布尔值 | 指示是否在 MyDay 视图中显示此任务。 如果 true为 ，则显示任务。 |
| isOnMyDayLastModifiedDate | 日期 | 此为只读属性。 在 MyDay 中添加或删除任务的日期。 |
| orderHint | String | 用于在列表视图中对此类项进行排序的提示。 有关详细信息，请参阅 在 planner n 中使用订单提示。 |
| percentComplete | Int32 | 任务完成百分比。 设置为 100时，任务已完成。 |
| priority | Int32 | 任务的优先级。 有效值介于 和 10之间0，包括 。 值越大，表示优先级越低。 例如， 0 优先级最高， 10 优先级最低。 目前，规划器将值0和 1 解释为“紧急”，2将 43 和 解释为“important”、5、 6和 7 “medium”，以及 8、 9和 10 “low”。 目前，planner 将值 1 设置为“紧急 3 ”、“重要”、“ 5 中”和 9 “低”。 |
| planId | String | 任务所属的计划 ID。 |
| previewType | String | 任务上显示的预览类型。 可取值为：automatic、noPreview、checklist、description、reference。 |
| recurrence | plannerTaskRecurrence | 定义任务的活动或非活动重复周期。
null 当从未为任务定义重复周期时。 |
| referenceCount | Int32 | 任务上存在的外部引用的数量。 |
| specifiedCompletionRequirements | plannerTaskCompletionRequirements | 指示 plannerTask 上指定的所有要求。 可取值为：none、checklistCompletion、unknownFutureValue、formCompletion、approvalCompletion。 只读。 必须使用 Prefer: include-unknown-enum-members 请求标头来获取此 可演变枚举中的以下值： formCompletion、 approvalCompletion。
plannerTaskDetails 中的 plannerTaskCompletionRequirementDetails 具有指定要求的详细信息（如果有）。 |
| startDateTime | DateTimeOffset | 任务开始的日期和时间。 时间戳类型表示采用 ISO 8601 格式的日期和时间信息，始终采用 UTC 时区。 例如，2014 年 1 月 1 日午夜 UTC 为 2014-01-01T00:00:00Z |
| title | String | 任务的标题。 |
plannerTaskCompletionRequirements 值
| 成员 | 说明 |
|---|---|
| 无 | 无要求。 |
| checklistCompletion | 需要检查部分或全部清单项。 |
| unknownFutureValue | 可演变枚举 sentinel 值。 请勿使用。 |
| formCompletion | 必须提交部分或全部表单才能完成规划器任务。 |
| approvalCompletion | 需要审批。 |
关系
| 关系 | 类型 | 说明 |
|---|---|---|
| assignedToTaskBoardFormat | plannerAssignedToTaskBoardTaskFormat | 此为只读属性。 可为 NULL。 用于在按 assignedTo 分组时在任务板视图中正确呈现任务。 |
| bucketTaskBoardFormat | plannerBucketTaskBoardTaskFormat | 此为只读属性。 可为 NULL。 用于在按存储桶分组时在任务板视图中正确呈现任务。 |
| 详细信息 | plannerTaskDetails | 此为只读属性。 可为 NULL。 有关任务的更多详细信息。 |
| progressTaskBoardFormat | plannerProgressTaskBoardTaskFormat | 此为只读属性。 可为 NULL。 用于在按进度分组时在任务板视图中正确呈现任务。 |
JSON 表示形式
以下 JSON 表示形式显示了资源类型。
{
"activeChecklistItemCount": "Int32",
"appliedCategories": {"@odata.type": "microsoft.graph.plannerAppliedCategories"},
"assigneePriority": "String",
"assignments": {"@odata.type": "microsoft.graph.plannerAssignments"},
"bucketId": "String",
"checklistItemCount": "Int32",
"completedBy": {"@odata.type": "microsoft.graph.identitySet"},
"completedDateTime": "String (timestamp)",
"conversationThreadId": "String",
"createdBy": {"@odata.type": "microsoft.graph.identitySet"},
"createdDateTime": "String (timestamp)",
"dueDateTime": "String (timestamp)",
"hasDescription": "Boolean",
"id": "String (identifier)",
"isOnMyDay": "Boolean",
"isOnMyDayLastModifiedDate": "Date",
"orderHint": "String",
"percentComplete": "Int32",
"planId": "String",
"previewType": "String",
"priority": "Int32",
"recurrence": {"@odata.type": "microsoft.graph.plannerTaskRecurrence"},
"referenceCount": "Int32",
"specifiedCompletionRequirements": "String",
"startDateTime": "String (timestamp)",
"title": "String"
}