计划者
借助 Microsoft Planner，可以轻松地将团队、任务、文档和对话组合在一起，从而获得更好的结果。
此连接器在以下产品和区域中可用：
| 服务 | Class | 区域 |
|---|---|---|
| Copilot Studio | 标准 | 除以下各项外的所有 Power Automate 区域 ： - 由世纪互联运营的中国云 |
| 逻辑应用程序 | 标准 | 除以下各项外的所有 逻辑应用区域 ： - Azure 中国区域 |
| Power Apps | 标准 | 除以下各项外的所有 Power Apps 区域 ： - 由世纪互联运营的中国云 |
| Power Automate | 标准 | 除以下各项外的所有 Power Automate 区域 ： - 由世纪互联运营的中国云 |
| 连接器元数据 | |
|---|---|
| 发布者 | Microsoft |
| 网站 | https://planner.cloud.microsoft |
有关详细信息，请参阅 Planner API 文档
已知问题和限制
重要
Planner 连接器目前仅支持基本计划。
请注意，某些作和触发器要求你提供一个 Group Id，但这仅用于填充其他依赖下拉列表（例如 ，创建任务 作会 Plan Id 根据提供的 Group Id下拉列表填充下拉列表）。 填充从属下拉列表后，任何值都可以插入到 Group Id 字段中，尽管连接器可能会提供有关 Group Id 该字段的任何警告，但该作仍按预期方式工作。
下面是上述作/触发器的完整列表：
正在创建连接
连接器支持以下身份验证类型：
| 默认 | 用于创建连接的参数。 | 所有区域 | 不可共享 |
违约
适用：所有区域
用于创建连接的参数。
这是不可共享的连接。 如果 Power App 与另一个用户共享，系统会提示其他用户显式创建新连接。
限制
| 名称 | 调用 | 续订期 |
|---|---|---|
| 每个连接的 API 调用数 | 100 | 60 秒 |
| 触发器轮询的频率 | 1 | 60 秒 |
操作
| 从任务中删除被分配者 |
从现有 Planner 任务中删除被分配者。 |
| 列出任务 |
列出分配给我的任务。 |
| 列出任务 |
列出计划中的任务。 |
| 列出任务 [已弃用] |
此作已弃用。 请改用 “列出我的任务 ”。
|
| 列出任务 [已弃用] |
此作已弃用。 请改用 列表任务 。
|
| 列出任务 [已弃用] |
此作已弃用。 请改用 列表任务 。
|
| 列出存储桶 |
列出计划中的存储桶。 |
| 列出存储桶 [已弃用] |
此作已弃用。 请改用 列表存储桶 。
|
| 列出存储桶 [已弃用] |
此作已弃用。 请改用 列表存储桶 。
|
| 列出我的计划 [已弃用] |
列出用户订阅的计划。 |
| 列出我的计划 [已弃用] |
列出用户订阅的计划。 |
| 列出组的计划 |
列出指定组拥有的计划。 |
| 创建任务 |
在 Planner 中创建新任务。 |
| 创建任务 [已弃用] |
此作已弃用。 请改用 “创建任务 ”。
|
| 创建任务 [已弃用] |
此作已弃用。 请改用 “创建任务 ”。
|
| 创建任务（预览版） |
在 Planner 中创建新任务。 |
| 创建存储桶 |
在 Planner 中创建指定计划和组的存储桶。 |
| 创建存储桶 [已弃用] |
此作已弃用。 请改用 创建存储桶 。
|
| 删除任务（预览版） |
删除现有的 Planner 任务。 |
| 向任务添加被分配者 |
向现有 Planner 任务添加被分配者。 |
| 更新任务 |
更新现有的 Planner 任务。 |
| 更新任务 [已弃用] |
此作已弃用。 请改用更新任务（V2）。
|
| 更新任务 （V2） （预览版） |
更新现有的 Planner 任务。 |
| 更新任务详细信息 |
更新现有任务的任务详细信息。 |
| 更新任务详细信息 [已弃用] |
此作已弃用。 请改用 更新任务详细信息 。
|
| 获取任务 |
获取现有的 Planner 任务。 |
| 获取任务 [已弃用] |
此作已弃用。 请改用 “获取任务 ”。
|
| 获取任务详细信息 |
获取现有任务的任务详细信息。 |
| 获取任务详细信息 [已弃用] |
此作已弃用。 请改用 “获取任务详细信息 ”。
|
| 获取计划详细信息（预览版） |
获取任务所属的计划详细信息 |
从任务中删除被分配者
从现有 Planner 任务中删除被分配者。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
任务 ID
|
id | True | string |
要更新的任务的唯一标识符。 |
|
删除分配的用户
|
assignments | True | string |
应取消分配此任务的用户的分号分隔 ID 或电子邮件地址。 |
返回
- Body
- GetTask_Response_V2
列出任务
列出任务
列出计划中的任务。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
组 ID
|
groupId | True | string |
要检索计划的组。 |
|
计划 ID
|
id | True | string |
计划的唯一标识符。 |
返回
列出任务 [已弃用]
列出任务 [已弃用]
此作已弃用。 请改用 列表任务 。
列出计划中的任务。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
计划 ID
|
id | True | string |
计划的唯一标识符。 |
返回
- Body
- ListTasks_Response
列出任务 [已弃用]
列出存储桶
列出计划中的存储桶。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
组 ID
|
groupId | True | string |
要检索计划的组。 |
|
计划 ID
|
id | True | string |
计划的唯一标识符。 |
返回
- Body
- ListBuckets_Response
列出存储桶 [已弃用]
此作已弃用。 请改用 列表存储桶 。
列出计划中的存储桶。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
计划 ID
|
id | True | string |
计划的唯一标识符。 |
返回
- Body
- ListBuckets_Response
列出存储桶 [已弃用]
此作已弃用。 请改用 列表存储桶 。
列出计划中的存储桶。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
计划 ID
|
id | True | string |
计划的唯一标识符。 |
返回
- Body
- ListBuckets_Response
列出我的计划 [已弃用]
列出我的计划 [已弃用]
列出组的计划
创建任务
在 Planner 中创建新任务。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
组 ID
|
groupId | True | string |
要检索计划的组。 |
|
计划 ID
|
planId | True | string |
新任务的计划。 |
|
Title
|
title | True | string |
新任务的标题（最多 255 个字符）。 |
|
存储桶 ID
|
bucketId | string |
要在其中放置此任务的存储桶。 |
|
|
开始日期时间
|
startDateTime | date-time |
任务开始的日期/时间（例如“2018-04-13T00：42：19.284Z”）。 |
|
|
截止日期时间
|
dueDateTime | date-time |
任务的截止日期（例如“2018-04-13T00：42：19.284Z”）。 |
|
|
分配的用户 ID
|
assignments | string |
要向其分配此任务的用户的分号分隔 ID 或电子邮件地址。 |
|
|
粉色
|
category1 | boolean |
如此 如果任务具有“粉红”类别。 |
|
|
红色
|
category2 | boolean |
如此 如果任务具有红色类别。 |
|
|
Yellow
|
category3 | boolean |
如此 如果任务具有黄色类别。 |
|
|
Green
|
category4 | boolean |
如此 如果任务具有绿色类别。 |
|
|
Blue
|
category5 | boolean |
如此 如果任务具有蓝色类别。 |
|
|
Purple
|
category6 | boolean |
如此 如果任务具有紫色类别。 |
|
|
青铜
|
category7 | boolean |
如此 如果任务具有铜级类别。 |
|
|
石灰
|
category8 | boolean |
如此 如果任务具有 Lime 类别。 |
|
|
Aqua
|
category9 | boolean |
如此 如果任务具有 Aqua 类别。 |
|
|
灰色
|
category10 | boolean |
如此 如果任务具有灰色类别。 |
|
|
银
|
category11 | boolean |
如此 如果任务具有 Silver 类别。 |
|
|
棕色
|
category12 | boolean |
如此 如果任务具有 Brown 类别。 |
|
|
蔓越桔
|
category13 | boolean |
如此 如果任务具有 Cranberry 类别。 |
|
|
Orange
|
category14 | boolean |
如此 如果任务具有 Orange 类别。 |
|
|
桃
|
category15 | boolean |
如此 如果任务具有 Peach 类别。 |
|
|
万寿菊
|
category16 | boolean |
如此 如果任务具有 Marigold 类别。 |
|
|
浅绿色
|
category17 | boolean |
如此 如果任务具有浅绿色类别。 |
|
|
深绿色
|
category18 | boolean |
如此 如果任务具有深绿色类别。 |
|
|
青绿色
|
category19 | boolean |
如此 如果任务具有 Teal 类别。 |
|
|
浅蓝色
|
category20 | boolean |
如此 如果任务具有浅蓝色类别。 |
|
|
深蓝色
|
category21 | boolean |
如此 如果任务具有深蓝色类别。 |
|
|
薰衣草
|
category22 | boolean |
如此 如果任务具有草草类别。 |
|
|
李子
|
category23 | boolean |
如此 如果任务具有 Plum 类别。 |
|
|
浅灰色
|
category24 | boolean |
如此 如果任务具有浅灰色类别。 |
|
|
深灰色
|
category25 | boolean |
如此 如果任务具有深灰色类别。 |
返回
- Body
- GetTask_Response_V2
创建任务 [已弃用]
此作已弃用。 请改用 “创建任务 ”。
在 Planner 中创建新任务。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
计划 ID
|
planId | True | string |
新任务的计划。 |
|
Title
|
title | True | string |
新任务的标题。 |
|
存储桶 ID
|
bucketId | string |
要在其中放置此任务的存储桶。 |
|
|
开始日期时间
|
startDateTime | date-time |
任务开始的日期/时间（例如“2018-04-13T00：42：19.284Z”）。 |
|
|
截止日期时间
|
dueDateTime | date-time |
任务的截止日期（例如“2018-04-13T00：42：19.284Z”）。 |
|
|
分配的用户 ID
|
assignments | string |
要向其分配此任务的用户的分号 ID 或电子邮件地址分号。 |
返回
- Body
- GetTask_Response_V2
创建任务 [已弃用]
此作已弃用。 请改用 “创建任务 ”。
在 Planner 中创建新任务。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
计划 ID
|
planId | True | string |
新任务的计划。 |
|
Title
|
title | True | string |
新任务的标题。 |
|
存储桶 ID
|
bucketId | string |
要在其中放置此任务的存储桶。 |
|
|
开始日期时间
|
startDateTime | date-time |
任务开始的日期/时间（例如“2018-04-13T00：42：19.284Z”）。 |
|
|
截止日期时间
|
dueDateTime | date-time |
任务的截止日期（例如“2018-04-13T00：42：19.284Z”）。 |
|
|
分配的用户 ID
|
assignments | string |
要向其分配此任务的用户的 ID 或电子邮件地址。 |
返回
- Body
- GetTask_Response
创建任务（预览版）
在 Planner 中创建新任务。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
组 ID
|
groupId | True | string |
要检索计划的组。 |
|
计划 ID
|
planId | True | string |
新任务的计划。 |
|
Title
|
title | True | string |
新任务的标题（最多 255 个字符）。 |
|
存储桶 ID
|
bucketId | string |
要在其中放置此任务的存储桶。 |
|
|
开始日期时间
|
startDateTime | date-time |
任务开始的日期/时间（例如“2018-04-13T00：42：19.284Z”）。 |
|
|
截止日期时间
|
dueDateTime | date-time |
任务的截止日期（例如“2018-04-13T00：42：19.284Z”）。 |
|
|
分配的用户 ID
|
assignments | string |
要向其分配此任务的用户的分号分隔 ID 或电子邮件地址。 |
|
|
粉色
|
category1 | boolean |
如此 如果任务具有“粉红”类别。 |
|
|
红色
|
category2 | boolean |
如此 如果任务具有红色类别。 |
|
|
Yellow
|
category3 | boolean |
如此 如果任务具有黄色类别。 |
|
|
Green
|
category4 | boolean |
如此 如果任务具有绿色类别。 |
|
|
Blue
|
category5 | boolean |
如此 如果任务具有蓝色类别。 |
|
|
Purple
|
category6 | boolean |
如此 如果任务具有紫色类别。 |
|
|
青铜
|
category7 | boolean |
如此 如果任务具有铜级类别。 |
|
|
石灰
|
category8 | boolean |
如此 如果任务具有 Lime 类别。 |
|
|
Aqua
|
category9 | boolean |
如此 如果任务具有 Aqua 类别。 |
|
|
灰色
|
category10 | boolean |
如此 如果任务具有灰色类别。 |
|
|
银
|
category11 | boolean |
如此 如果任务具有 Silver 类别。 |
|
|
棕色
|
category12 | boolean |
如此 如果任务具有 Brown 类别。 |
|
|
蔓越桔
|
category13 | boolean |
如此 如果任务具有 Cranberry 类别。 |
|
|
Orange
|
category14 | boolean |
如此 如果任务具有 Orange 类别。 |
|
|
桃
|
category15 | boolean |
如此 如果任务具有 Peach 类别。 |
|
|
万寿菊
|
category16 | boolean |
如此 如果任务具有 Marigold 类别。 |
|
|
浅绿色
|
category17 | boolean |
如此 如果任务具有浅绿色类别。 |
|
|
深绿色
|
category18 | boolean |
如此 如果任务具有深绿色类别。 |
|
|
青绿色
|
category19 | boolean |
如此 如果任务具有 Teal 类别。 |
|
|
浅蓝色
|
category20 | boolean |
如此 如果任务具有浅蓝色类别。 |
|
|
深蓝色
|
category21 | boolean |
如此 如果任务具有深蓝色类别。 |
|
|
薰衣草
|
category22 | boolean |
如此 如果任务具有草草类别。 |
|
|
李子
|
category23 | boolean |
如此 如果任务具有 Plum 类别。 |
|
|
浅灰色
|
category24 | boolean |
如此 如果任务具有浅灰色类别。 |
|
|
深灰色
|
category25 | boolean |
如此 如果任务具有深灰色类别。 |
|
|
Priority
|
priority | integer |
任务的优先级。 有效值范围介于 0 和 10 之间（含），值递增优先级较低（0 具有最高优先级，10 具有最低优先级）。 目前，Planner 将值 0 和 1 解释为“紧急”、2 和 3 和 4 为“重要”、“5、6 和 7”中等“，将 8、9 和 10 的值解释为”low”。 目前，Planner 将值 1 设置为“紧急”，3 表示“重要”，5 表示“中等”，9 表示“low”。 |
返回
- Body
- GetTask_Response_V3
创建存储桶
在 Planner 中创建指定计划和组的存储桶。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Name
|
name | True | string |
存储桶的名称 |
|
组 ID
|
groupId | True | string |
要检索计划的组。 |
|
计划 ID
|
planId | True | string |
新存储桶的计划。 |
返回
创建存储桶 [已弃用]
此作已弃用。 请改用 创建存储桶 。
在 Planner 中创建存储桶。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Name
|
name | True | string |
存储桶的名称 |
|
计划 ID
|
planId | True | string |
新存储桶的计划 |
返回
删除任务（预览版）
删除现有的 Planner 任务。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
任务 ID
|
id | True | string |
要删除的任务的唯一标识符。 |
向任务添加被分配者
向现有 Planner 任务添加被分配者。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
任务 ID
|
id | True | string |
要更新的任务的唯一标识符。 |
|
分配的用户 ID
|
assignments | True | string |
应分配给此任务的用户的分号分隔 ID 或电子邮件地址。 |
返回
- Body
- GetTask_Response_V2
更新任务
更新现有的 Planner 任务。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
任务 ID
|
id | True | string |
要更新的任务的唯一标识符。 |
|
Title
|
title | string |
计划的标题。 |
|
|
截止日期 Date-Time
|
dueDateTime | date-time |
任务的截止日期（例如“2018-04-13T00：42：19.284Z”）。 |
|
|
开始 Date-Time
|
startDateTime | date-time |
任务开始的日期/时间（例如“2018-04-13T00：42：19.284Z”）。 |
|
|
进展
|
percentComplete | string |
任务的进度。 |
|
|
添加分配的用户
|
assignments | string |
应分配给此任务的用户的分号分隔 ID 或电子邮件地址。 |
|
|
删除分配的用户
|
unassignedUsers | string |
应从此任务中取消分配的用户的分号分隔 ID 或电子邮件地址。 |
返回
- Body
- GetTask_Response_V2
更新任务 [已弃用]
此作已弃用。 请改用更新任务（V2）。
更新现有的 Planner 任务。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
任务 ID
|
id | True | string |
要更新的塔斯特的唯一标识符。 |
|
Title
|
title | string |
计划的标题。 |
|
|
截止日期 Date-Time
|
dueDateTime | date-time |
任务的截止日期（例如“2018-04-13T00：42：19.284Z”）。 |
|
|
开始 Date-Time
|
startDateTime | date-time |
任务开始的日期/时间（例如“2018-04-13T00：42：19.284Z”）。 |
|
|
进展
|
percentComplete | string |
任务的进度。 |
|
|
Assisgned User Id
|
assignments | string |
要向其分配此任务的用户的 ID 或电子邮件地址。 |
返回
- Body
- GetTask_Response
更新任务 （V2） （预览版）
更新现有的 Planner 任务。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
任务 ID
|
id | True | string |
要更新的任务的唯一标识符。 |
|
Title
|
title | string |
计划的标题（最多 255 个字符）。 |
|
|
截止日期 Date-Time
|
dueDateTime | date-time |
任务的截止日期（例如“2018-04-13T00：42：19.284Z”）。 |
|
|
开始 Date-Time
|
startDateTime | date-time |
任务开始的日期/时间（例如“2018-04-13T00：42：19.284Z”）。 |
|
|
完成百分比
|
percentComplete | integer |
任务的完成百分比。 |
|
|
存储桶 ID
|
bucketId | string |
要在其中放置此任务的存储桶。 |
|
|
粉色
|
category1 | boolean |
如此 如果任务具有“粉红”类别。 |
|
|
红色
|
category2 | boolean |
如此 如果任务具有红色类别。 |
|
|
Yellow
|
category3 | boolean |
如此 如果任务具有黄色类别。 |
|
|
Green
|
category4 | boolean |
如此 如果任务具有绿色类别。 |
|
|
Blue
|
category5 | boolean |
如此 如果任务具有蓝色类别。 |
|
|
Purple
|
category6 | boolean |
如此 如果任务具有紫色类别。 |
|
|
青铜
|
category7 | boolean |
如此 如果任务具有铜级类别。 |
|
|
石灰
|
category8 | boolean |
如此 如果任务具有 Lime 类别。 |
|
|
Aqua
|
category9 | boolean |
如此 如果任务具有 Aqua 类别。 |
|
|
灰色
|
category10 | boolean |
如此 如果任务具有灰色类别。 |
|
|
银
|
category11 | boolean |
如此 如果任务具有 Silver 类别。 |
|
|
棕色
|
category12 | boolean |
如此 如果任务具有 Brown 类别。 |
|
|
蔓越桔
|
category13 | boolean |
如此 如果任务具有 Cranberry 类别。 |
|
|
Orange
|
category14 | boolean |
如此 如果任务具有 Orange 类别。 |
|
|
桃
|
category15 | boolean |
如此 如果任务具有 Peach 类别。 |
|
|
万寿菊
|
category16 | boolean |
如此 如果任务具有 Marigold 类别。 |
|
|
浅绿色
|
category17 | boolean |
如此 如果任务具有浅绿色类别。 |
|
|
深绿色
|
category18 | boolean |
如此 如果任务具有深绿色类别。 |
|
|
青绿色
|
category19 | boolean |
如此 如果任务具有 Teal 类别。 |
|
|
浅蓝色
|
category20 | boolean |
如此 如果任务具有浅蓝色类别。 |
|
|
深蓝色
|
category21 | boolean |
如此 如果任务具有深蓝色类别。 |
|
|
薰衣草
|
category22 | boolean |
如此 如果任务具有草草类别。 |
|
|
李子
|
category23 | boolean |
如此 如果任务具有 Plum 类别。 |
|
|
浅灰色
|
category24 | boolean |
如此 如果任务具有浅灰色类别。 |
|
|
深灰色
|
category25 | boolean |
如此 如果任务具有深灰色类别。 |
返回
- Body
- GetTask_Response_V2
更新任务详细信息
更新现有任务的任务详细信息。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
任务 ID
|
id | True | string |
要更新的任务的唯一标识符。 |
|
Description
|
description | string |
任务的说明。 |
|
|
别名
|
alias | string |
用于描述引用的名称别名。 |
|
|
资源链接
|
resourceLink | True | uri |
基于 HTTP/HTTPS 协议的有效 URL。 |
|
引用的类型
|
type |
用于描述引用的类型。 |
||
|
Id
|
id | True | string |
表示清单项的数字。 |
|
Title
|
title | True | string |
清单项的名称。 |
|
已选中
|
isChecked | True | boolean |
是否检查该项。 |
返回
更新任务详细信息 [已弃用]
此作已弃用。 请改用 更新任务详细信息 。
更新现有任务的任务详细信息。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
任务 ID
|
id | True | string |
任务的唯一标识器。 |
|
Description
|
description | string |
任务的说明。 |
|
|
别名
|
alias | string |
用于描述引用的名称别名。 |
|
|
资源链接
|
resourceLink | True | uri |
基于 HTTP/HTTPS 协议的有效 URL。 |
|
引用的类型
|
type |
用于描述引用的类型。 |
||
|
Id
|
id | True | string |
表示清单项的数字。 |
|
Title
|
title | True | string |
清单项的名称。 |
|
已选中
|
isChecked | True | boolean |
是否检查该项。 |
返回
获取任务
获取任务 [已弃用]
此作已弃用。 请改用 “获取任务 ”。
获取现有的 Planner 任务。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
任务 ID
|
id | True | string |
任务的唯一标识器。 |
返回
- Body
- GetTask_Response
获取任务详细信息
获取任务详细信息 [已弃用]
获取计划详细信息（预览版）
触发器
| 任务完成后 |
此作在任务完成时触发。 |
| 任务完成后 [已弃用] |
此作已弃用。 请改用 任务完成时间 。
|
| 任务完成后 [已弃用] |
此作已弃用。 请改用 任务完成时间 。
|
| 创建新任务时 |
此作在创建新任务时触发。 |
| 创建新任务时 [已弃用] |
此作已弃用。 请改用 创建新任务时 。
|
| 创建新任务时 [已弃用] |
此作已弃用。 请改用 创建新任务时 。
|
| 将任务分配给我时 |
向我分配任务时，此作将触发。 |
| 将任务分配给我时 [已弃用] |
此作已弃用。 请改用 任务分配给我 。
|
任务完成后
此作在任务完成时触发。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
组 ID
|
groupId | True | string |
要检索计划的组。 |
|
计划 ID
|
id | True | string |
计划的唯一标识符。 |
返回
任务完成后 [已弃用]
任务完成后 [已弃用]
此作已弃用。 请改用 任务完成时间 。
此作在任务完成时触发。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
计划 ID
|
id | True | string |
计划的唯一标识符。 |
返回
- Body
- ListTasks_Response
创建新任务时
此作在创建新任务时触发。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
组 ID
|
groupId | True | string |
要检索计划的组。 |
|
计划 ID
|
id | True | string |
计划的唯一标识符。 |
返回
创建新任务时 [已弃用]
创建新任务时 [已弃用]
此作已弃用。 请改用 创建新任务时 。
此作在创建新任务时触发。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
计划 ID
|
id | True | string |
计划的唯一标识符。 |
返回
- Body
- ListTasks_Response
将任务分配给我时
将任务分配给我时 [已弃用]
定义
ListBuckets_Response
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
value
|
value | array of object | |
|
Name
|
value.name | string |
存储桶的名称。 |
|
计划 ID
|
value.planId | string |
此存储桶所属的计划 ID。 |
|
Id
|
value.id | string |
存储桶的 ID。 |
ListMyPlans_Response
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
value
|
value | array of object | |
|
Title
|
value.title | string |
计划的标题。 |
|
Id
|
value.id | string |
计划的 ID。 |
GetTaskDetails_Response
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Description
|
description | string |
任务的说明。 |
|
Id
|
id | string |
任务的 ID。 |
|
References
|
references | array of object |
任务的引用集合 |
|
资源链接
|
references.resourceLink | uri |
基于 HTTP/HTTPS 协议的有效 URL。 |
|
别名
|
references.value.alias | string |
用于描述引用的名称别名。 |
|
引用的类型
|
references.value.type |
用于描述引用的类型。 |
|
|
清单
|
checklist | array of object |
任务的清单项的集合。 |
|
Id
|
checklist.id | string |
表示清单项的数字。 |
|
Title
|
checklist.value.title | string |
清单项的名称。 |
|
已选中
|
checklist.value.isChecked | boolean |
是否检查该项。 |
CreateBucket_Response
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Name
|
name | string |
存储桶的名称 |
|
计划 ID
|
planId | string |
存储桶所属的计划 ID |
|
订单提示
|
orderHint | string |
用于在列表视图中订购此类型的项的提示 |
|
Id
|
id | string |
存储桶的 ID |
GetTask_Response_V2
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
显示名称
|
createdBy.user.displayName | string |
创建此任务的用户的显示名称。 |
|
Id
|
createdBy.user.id | string |
创建此任务的用户的 ID。 |
|
计划 ID
|
planId | string |
此任务所属的计划 ID。 |
|
存储桶 ID
|
bucketId | string |
此任务所属的存储桶的 ID。 |
|
Title
|
title | string |
任务的标题。 |
|
完成百分比
|
percentComplete | integer |
任务的完成百分比。 |
|
开始日期时间
|
startDateTime | date-time |
任务的开始日期时间。 |
|
创建日期时间
|
createdDateTime | date-time |
任务的创建日期/时间。 |
|
截止日期时间
|
dueDateTime | date-time |
任务到期的日期/时间。 |
|
具有说明
|
hasDescription | boolean |
如果任务有说明，则设置为 true。 |
|
已完成日期时间
|
completedDateTime | date-time |
任务的完成日期/时间。 |
|
引用计数
|
referenceCount | integer |
任务上存在的外部引用数。 |
|
Id
|
id | string |
任务的 ID。 |
|
appliedCategories
|
appliedCategories | AppliedCategories |
任务已应用到的类别。 |
|
assignments
|
_assignments | array of object | |
|
分配给用户 ID
|
_assignments.userId | string |
向其分配此任务的用户的 ID。 |
|
按用户 ID 分配
|
_assignments.value.assignedBy.user.id | string |
分配此任务的用户的 ID。 |
|
分配的日期时间
|
_assignments.value.assignedDateTime | date-time |
分配任务的日期/时间。 |
|
订单提示
|
_assignments.value.orderHint | string |
订单提示 |
GetTask_Response_V3
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
显示名称
|
createdBy.user.displayName | string |
创建此任务的用户的显示名称。 |
|
Id
|
createdBy.user.id | string |
创建此任务的用户的 ID。 |
|
计划 ID
|
planId | string |
此任务所属的计划 ID。 |
|
存储桶 ID
|
bucketId | string |
此任务所属的存储桶的 ID。 |
|
Title
|
title | string |
任务的标题。 |
|
完成百分比
|
percentComplete | integer |
任务的完成百分比。 |
|
开始日期时间
|
startDateTime | date-time |
任务的开始日期时间。 |
|
创建日期时间
|
createdDateTime | date-time |
任务的创建日期/时间。 |
|
截止日期时间
|
dueDateTime | date-time |
任务到期的日期/时间。 |
|
具有说明
|
hasDescription | boolean |
如果任务有说明，则设置为 true。 |
|
已完成日期时间
|
completedDateTime | date-time |
任务的完成日期/时间。 |
|
引用计数
|
referenceCount | integer |
任务上存在的外部引用数。 |
|
Id
|
id | string |
任务的 ID。 |
|
appliedCategories
|
appliedCategories | AppliedCategories |
任务已应用到的类别。 |
|
Priority
|
priority | integer |
任务的优先级。 有效值范围介于 0 和 10 之间（含），值递增优先级较低（0 具有最高优先级，10 具有最低优先级）。 目前，Planner 将值 0 和 1 解释为“紧急”、2 和 3 和 4 为“重要”、“5、6 和 7”中等“，将 8、9 和 10 的值解释为”low”。 目前，Planner 将值 1 设置为“紧急”，3 表示“重要”，5 表示“中等”，9 表示“low”。 |
|
assignments
|
_assignments | array of object | |
|
分配给用户 ID
|
_assignments.userId | string |
向其分配此任务的用户的 ID。 |
|
按用户 ID 分配
|
_assignments.value.assignedBy.user.id | string |
分配此任务的用户的 ID。 |
|
分配的日期时间
|
_assignments.value.assignedDateTime | date-time |
分配任务的日期/时间。 |
|
订单提示
|
_assignments.value.orderHint | string |
订单提示 |
ListTasks_Response_V2
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
value
|
value | array of GetTask_Response_V2 |
AppliedCategories
任务已应用到的类别。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
粉色
|
category1 | boolean |
如此 如果任务具有“粉红”类别。 |
|
红色
|
category2 | boolean |
如此 如果任务具有红色类别。 |
|
Yellow
|
category3 | boolean |
如此 如果任务具有黄色类别。 |
|
Green
|
category4 | boolean |
如此 如果任务具有绿色类别。 |
|
Blue
|
category5 | boolean |
如此 如果任务具有蓝色类别。 |
|
Purple
|
category6 | boolean |
如此 如果任务具有紫色类别。 |
|
青铜
|
category7 | boolean |
如此 如果任务具有铜级类别。 |
|
石灰
|
category8 | boolean |
如此 如果任务具有 Lime 类别。 |
|
Aqua
|
category9 | boolean |
如此 如果任务具有 Aqua 类别。 |
|
灰色
|
category10 | boolean |
如此 如果任务具有灰色类别。 |
|
银
|
category11 | boolean |
如此 如果任务具有 Silver 类别。 |
|
棕色
|
category12 | boolean |
如此 如果任务具有 Brown 类别。 |
|
蔓越桔
|
category13 | boolean |
如此 如果任务具有 Cranberry 类别。 |
|
Orange
|
category14 | boolean |
如此 如果任务具有 Orange 类别。 |
|
桃
|
category15 | boolean |
如此 如果任务具有 Peach 类别。 |
|
万寿菊
|
category16 | boolean |
如此 如果任务具有 Marigold 类别。 |
|
浅绿色
|
category17 | boolean |
如此 如果任务具有浅绿色类别。 |
|
深绿色
|
category18 | boolean |
如此 如果任务具有深绿色类别。 |
|
青绿色
|
category19 | boolean |
如此 如果任务具有 Teal 类别。 |
|
浅蓝色
|
category20 | boolean |
如此 如果任务具有浅蓝色类别。 |
|
深蓝色
|
category21 | boolean |
如此 如果任务具有深蓝色类别。 |
|
薰衣草
|
category22 | boolean |
如此 如果任务具有草草类别。 |
|
李子
|
category23 | boolean |
如此 如果任务具有 Plum 类别。 |
|
浅灰色
|
category24 | boolean |
如此 如果任务具有浅灰色类别。 |
|
深灰色
|
category25 | boolean |
如此 如果任务具有深灰色类别。 |
GetTask_Response
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
显示名称
|
createdBy.user.displayName | string |
创建此任务的用户的显示名称。 |
|
Id
|
createdBy.user.id | string |
创建此任务的用户的 ID。 |
|
计划 ID
|
planId | string |
此任务所属的计划 ID。 |
|
存储桶 ID
|
bucketId | string |
此任务所属的存储桶的 ID。 |
|
Title
|
title | string |
任务的标题。 |
|
完成百分比
|
percentComplete | integer |
任务的完成百分比。 |
|
开始日期时间
|
startDateTime | date-time |
任务的开始日期时间。 |
|
创建日期时间
|
createdDateTime | date-time |
任务的创建日期/时间。 |
|
截止日期时间
|
dueDateTime | date-time |
任务到期的日期/时间。 |
|
具有说明
|
hasDescription | boolean |
如果任务有说明，则设置为 true。 |
|
已完成日期时间
|
completedDateTime | date-time |
任务的完成日期/时间。 |
|
引用计数
|
referenceCount | integer |
任务上存在的外部引用数。 |
|
Id
|
id | string |
任务的 ID。 |
ListTasks_Response
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
value
|
value | array of object | |
|
按显示名称创建
|
value.createdBy.user.displayName | string |
创建此任务的用户的显示名称。 |
|
Id
|
value.createdBy.user.id | string |
创建此任务的用户的 ID。 |
|
按显示名称完成
|
value.completedBy.user.displayName | string |
displayName |
|
id
|
value.completedBy.user.id | string |
id |
|
计划 ID
|
value.planId | string |
此任务所属的计划 ID。 |
|
存储桶 ID
|
value.bucketId | string |
此任务所属的存储桶的 ID。 |
|
Title
|
value.title | string |
任务的标题。 |
|
完成百分比
|
value.percentComplete | integer |
任务的完成百分比。 |
|
开始日期时间
|
value.startDateTime | date-time |
任务的开始日期时间。 |
|
创建日期时间
|
value.createdDateTime | date-time |
任务的创建日期/时间。 |
|
截止日期时间
|
value.dueDateTime | date-time |
任务到期的日期/时间。 |
|
具有说明
|
value.hasDescription | boolean |
如果任务有说明，则设置为 True。 |
|
已完成日期时间
|
value.completedDateTime | date-time |
任务完成的日期时间。 |
|
引用计数
|
value.referenceCount | integer |
任务上存在的外部引用数。 |
|
Id
|
value.id | string |
任务的 ID。 |
GetPlanDetails_Response
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
类别 1
|
categoryDescriptions.category1 | string |
类别 1。 |
|
类别 2
|
categoryDescriptions.category2 | string |
类别 2。 |
|
类别 3
|
categoryDescriptions.category3 | string |
类别 3。 |
|
类别 4
|
categoryDescriptions.category4 | string |
类别 4。 |
|
类别 5
|
categoryDescriptions.category5 | string |
类别 5。 |
|
类别 6
|
categoryDescriptions.category6 | string |
类别 6。 |
|
类别 7
|
categoryDescriptions.category7 | string |
类别 7。 |
|
类别 8
|
categoryDescriptions.category8 | string |
类别 8。 |
|
类别 9
|
categoryDescriptions.category9 | string |
类别 9。 |
|
类别 10
|
categoryDescriptions.category10 | string |
类别 10。 |
|
类别 11
|
categoryDescriptions.category11 | string |
类别 11。 |
|
类别 12
|
categoryDescriptions.category12 | string |
类别 12。 |
|
类别 13
|
categoryDescriptions.category13 | string |
类别 13。 |
|
类别 14
|
categoryDescriptions.category14 | string |
类别 14。 |
|
类别 15
|
categoryDescriptions.category15 | string |
类别 15。 |
|
类别 16
|
categoryDescriptions.category16 | string |
类别 16。 |
|
类别 17
|
categoryDescriptions.category17 | string |
类别 17。 |
|
类别 18
|
categoryDescriptions.category18 | string |
类别 18。 |
|
类别 19
|
categoryDescriptions.category19 | string |
类别 19。 |
|
类别 20
|
categoryDescriptions.category20 | string |
类别 20。 |
|
类别 21
|
categoryDescriptions.category21 | string |
类别 21。 |
|
类别 22
|
categoryDescriptions.category22 | string |
类别 22。 |
|
类别 23
|
categoryDescriptions.category23 | string |
类别 23。 |
|
类别 24
|
categoryDescriptions.category24 | string |
类别 24。 |
|
类别 25
|
categoryDescriptions.category25 | string |
类别 25。 |
|
Id
|
id | string |
计划详细信息的 ID |