地震计划（预览版）
Seismic Program 连接器提供一系列作和触发器，旨在与地震计划产品中的关键功能进行交互。 其中包括跟踪正在进行的启用计划的进度和配置的程序;任务，用于监视团队活动的工作管理工具;和请求，使外部团队成员能够将工作请求提交到团队。
此连接器在以下产品和区域中可用：
| 服务 | Class | 区域 |
|---|---|---|
| Copilot Studio | 高级 | 除以下各项外的所有 Power Automate 区域 ： - 美国政府 （GCC） - 美国政府 （GCC High） - 由世纪互联运营的中国云 - 美国国防部（DoD） |
| 逻辑应用程序 | 标准 | 除以下各项外的所有 逻辑应用区域 ： - Azure 政府区域 - Azure 中国区域 - 美国国防部（DoD） |
| Power Apps | 高级 | 除以下各项外的所有 Power Apps 区域 ： - 美国政府 （GCC） - 美国政府 （GCC High） - 由世纪互联运营的中国云 - 美国国防部（DoD） |
| Power Automate | 高级 | 除以下各项外的所有 Power Automate 区域 ： - 美国政府 （GCC） - 美国政府 （GCC High） - 由世纪互联运营的中国云 - 美国国防部（DoD） |
| 联系人 | |
|---|---|
| Name | 地震的 |
| URL | https://seismic.com |
| support@seismic.com |
| 连接器元数据 | |
|---|---|
| 发布者 | Seismic Software |
| Website | https://seismic.com/ |
| 隐私策略 | https://seismic.com/privacy-policy/ |
| 类别 | 营销;销售和 CRM |
Seismic Program 连接器
Seismic Program 连接器提供一系列作和触发器，旨在与地震计划产品中的关键功能进行交互。 其中包括跟踪正在进行的启用计划的进度和配置的程序;任务，用于监视团队活动的工作管理工具;和请求，使外部团队成员能够将工作请求提交到团队。
发布者：Seismic
先决条件
需要租户的 Seismic Premium 用户帐户。
支持的作
获取批注
获取单个节点上的注释列表（程序、任务、请求）。
获取批注
在单个节点（程序、任务、请求）上获取单个注释。
创建注释
在单个节点（程序、任务、请求）上创建注释。
更新批注
更新单个节点上的现有注释（程序、任务、请求）。
删除批注
删除对单个节点（程序、任务、请求）的注释。
获取程序
获取租户中的程序列表。
获取程序
获取租户中的单个程序。
创建程序
在租户中创建程序。
更新程序
更新租户中的现有程序。
删除程序
删除租户中的程序列表。
删除程序
删除租户中的程序。
获取请求
获取租户中的请求列表。
获取请求
获取租户中的单个请求。
创建请求
在租户中创建请求。
更新请求
更新租户中的单个请求。
删除请求
删除租户中的单个请求。
删除请求
删除租户中的请求列表。
获取任务
获取租户中的任务列表。
获取任务
获取租户中的单个任务。
创建任务
在租户中创建任务。
更新任务
更新租户中的单个任务。
删除任务
删除租户中的单个任务。
删除任务
删除租户中的任务列表。
获取状态架构
获取状态架构的列表。
获取状态架构
获取单个状态架构
触发器：创建程序时
一个触发器，它使用 ProgramCreate webhook 在创建程序数据后返回程序数据
触发器：更新程序时
一个触发器，它使用 ProgramUpdate webhook 在更新程序数据后返回程序数据
触发器：删除程序时
一个触发器，它使用 ProgramDelete Webhook 在删除程序数据后返回程序数据
触发器：创建任务时
使用 ProgramTaskCreate Webhook 在创建任务数据后返回任务的触发器
触发器：更新任务时
一个触发器，它使用 ProgramTaskUpdate Webhook 在更新任务数据后返回任务数据
触发器：删除任务时
一个触发器，它使用 ProgramTaskDelete Webhook 在删除任务数据后返回任务数据
触发器：创建请求时
使用 ProgramRequestCreate Webhook 在创建请求数据后返回请求数据的触发器
触发器：更新请求时
使用 ProgramRequestUpdate Webhook 在更新请求数据后返回请求数据的触发器
触发器：删除请求时
使用 ProgramRequestDelete Webhook 在删除请求数据后返回请求数据的触发器
获取凭据
需要租户的 Seismic Premium 用户帐户。 如果没有足够的权限，请联系 Seismic 系统管理员。
入门
Seismic Programs 连接器包括以下作。 每个作对应于 API 终结点。 有关与作关联的字段和属性的详细信息，请参阅每个相应的 API 终结点的文章。
- 获取批注
- 获取批注
- 创建注释
- 更新批注
- 删除批注
- 获取程序
- 获取程序
- 创建程序
- 更新程序
- 删除程序
- 删除程序
- 获取请求
- 获取请求
- 创建请求
- 更新请求
- 删除请求
- 删除请求
- 获取任务
- 获取任务
- 创建任务
- 更新任务
- 删除任务
- 删除任务
- 触发器：程序创建
- 触发器：程序更新
- 触发器：程序删除
- 触发器：任务创建
- 触发器：任务更新
- 触发器：任务删除
- 触发器：请求创建
- 触发器：请求更新
- 触发器：请求删除
已知问题和限制
目前没有已知问题和限制。 所有 API 都按照地震 API 策略运行，包括速率限制。 有关 API 规范、限制和标准，请参阅 Seismic 开发人员门户 。
部署说明
请使用 这些说明 将此连接器部署为 Microsoft Power Automate 和 Power Apps 中的自定义连接器。
限制
| 名称 | 调用 | 续订期 |
|---|---|---|
| 每个连接的 API 调用数 | 100 | 60 秒 |
操作
| Get 请求 |
获取单个请求。 |
| 创建任务 |
创建任务。 |
| 创建注释 |
针对给定的程序、任务或请求创建注释。 需要节点（程序、任务或请求）ID。 |
| 创建程序 |
创建程序。 |
| 创建请求 |
创建请求。 |
| 删除任务 |
删除任务。 |
| 删除批注 |
删除批注。 需要节点（程序、任务或请求）和注释 ID。 |
| 删除程序 |
删除程序。 |
| 删除程序 |
删除一个或多个程序。 |
| 删除请求 |
删除请求。 |
| 删除请求 |
批量删除请求。 |
| 更新任务 |
更新现有任务。 |
| 更新注释 |
更新现有注释。 需要节点（程序、任务或请求）和注释 ID。 |
| 更新程序 |
更新并返回程序。 |
| 更新请求 |
更新请求。 |
| 获取任务 |
按 ID 获取单个任务。 |
| 获取任务 |
获取任务列表。 |
| 获取批注 |
获取单个注释。 需要节点（程序、任务或请求）和注释 ID。 |
| 获取批注 |
获取给定程序、任务或请求的所有注释。 需要节点（程序、任务或请求）ID。 |
| 获取状态架构 |
按 ID 获取单个状态架构。 这些架构保存特定工作设置状态的数据。 示例： |
| 获取状态架构 |
获取任务/请求状态架构的列表。 这些架构保存特定工作设置状态的数据。 示例： |
| 获取程序 |
按 ID 获取单个程序。 如果需要，则返回任务。 |
| 获取程序 |
获取具有其属性和关联的程序的列表。 |
| 获取请求 |
获取请求列表。 |
Get 请求
获取单个请求。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
空间 ID
|
spaceId | True | string |
空间 ID |
|
请求编号
|
requestId | True | string |
请求编号 |
返回
- Body
- ProgramRequest
创建任务
创建任务。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
空间 ID
|
spaceId | True | string |
空间 ID |
|
被分配者 ID
|
assigneeId | string |
被分配者的用户 ID |
|
|
节点 ID
|
nodeId | string |
节点 ID |
|
|
节点类型
|
nodeType | string |
关联的节点类型 |
|
|
空间 ID
|
spaceId | string |
空间 ID |
|
|
自定义属性 ID
|
id | string | ||
|
值 ID
|
id | string | ||
|
价值
|
value |
自定义属性值的值数据 |
||
|
Description
|
description | string |
任务说明 |
|
|
父 ID
|
parentId | string |
父级的任务 ID |
|
|
计划工期
|
plannedDuration | integer |
计划工期（以天为单位） |
|
|
计划结束日期
|
plannedEndDate | date-time |
结束日期的日期字符串 |
|
|
计划开始日期
|
plannedStartDate | date-time |
开始日期的日期字符串 |
|
|
Priority
|
priority | string |
优先级值 |
|
|
程序 ID
|
programId | string |
任务与 |
|
|
Title
|
title | True | string |
任务标题 |
返回
- Body
- ProgramTask
创建注释
针对给定的程序、任务或请求创建注释。 需要节点（程序、任务或请求）ID。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
空间 ID
|
spaceId | True | string |
空间 ID |
|
节点 ID
|
nodeId | True | string |
节点 ID |
|
批注有效负载
|
annotationPayload | string | ||
|
批注类型
|
annotationType | string |
批注类型 |
|
|
注释内容
|
commentContent | True | string |
批注的内容 |
|
已解决
|
isResolved | boolean |
是否解析批注时为 True/false |
返回
- Body
- Comment
创建程序
创建程序。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
空间 ID
|
spaceId | True | string |
空间 ID |
|
节点 ID
|
nodeId | string |
节点 ID |
|
|
节点类型
|
nodeType | string |
关联的节点类型 |
|
|
空间 ID
|
spaceId | string |
空间 ID |
|
|
自定义属性 ID
|
id | string | ||
|
值 ID
|
id | string | ||
|
价值
|
value |
自定义属性值的值数据 |
||
|
Description
|
description | string |
说明标题 |
|
|
管理器 ID
|
managerId | string |
管理器的用户 ID |
|
|
计划工期
|
plannedDuration | integer |
计划工期（以天为单位） |
|
|
计划结束日期
|
plannedEndDate | date-time |
结束日期的日期字符串 |
|
|
计划开始日期
|
plannedStartDate | date-time |
开始日期的日期字符串 |
|
|
Title
|
title | True | string |
程序标题 |
返回
- Body
- Program
创建请求
创建请求。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
空间 ID
|
spaceId | True | string |
空间 ID |
|
被分配者 ID
|
assigneeId | string |
被分配者的用户 ID |
|
|
节点 ID
|
nodeId | string |
节点 ID |
|
|
节点类型
|
nodeType | string |
关联的节点类型 |
|
|
空间 ID
|
spaceId | string |
空间 ID |
|
|
内容 ID
|
contentId | uuid |
内容 ID |
|
|
DocCenter 完整路径
|
docCenterFullPath | string |
DocCenter 中存在内容的完整位置路径 |
|
|
主要版本
|
majorVersion | integer |
主版本数 |
|
|
次要版本
|
minorVersion | integer |
次要版本数 |
|
|
修改日期
|
modifiedDate | date-time |
上次更新内容引用的日期 |
|
|
订单编号
|
orderNo | integer |
指示订单的数字 |
|
|
配置文件 ID
|
profileId | uuid |
配置文件 ID |
|
|
配置文件版本 ID
|
profileVersionId | uuid |
配置文件的版本 ID |
|
|
来源
|
source | string |
内容源 |
|
|
TeamSite ID
|
teamSiteId | string |
TeamSite ID |
|
|
缩略图 ID
|
thumbnailId | string |
图像缩略图的 ID |
|
|
版本 ID
|
versionId | uuid |
内容的版本 ID |
|
|
自定义属性 ID
|
id | string | ||
|
值 ID
|
id | string | ||
|
价值
|
value |
自定义属性值的值数据 |
||
|
表单参考
|
formRef | True |
表单引用对象 |
|
|
计划工期
|
plannedDuration | integer |
计划工期（以天为单位） |
|
|
计划结束日期
|
plannedEndDate | date-time |
结束日期的日期字符串 |
|
|
计划开始日期
|
plannedStartDate | date-time |
开始日期的日期字符串 |
|
|
Priority
|
priority | string |
优先级值 |
|
|
程序 ID
|
programId | string |
请求所属的程序 ID |
|
|
状态架构 ID
|
statusSchemaId | string | ||
|
Title
|
title | True | string |
请求标题 |
返回
- Body
- ProgramRequest
删除任务
删除任务。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
空间 ID
|
spaceId | True | string |
空间 ID |
|
任务 ID
|
taskId | True | string |
任务 ID |
返回
删除批注
删除批注。 需要节点（程序、任务或请求）和注释 ID。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
空间 ID
|
spaceId | True | string |
空间 ID |
|
节点 ID
|
nodeId | True | string |
节点 ID |
|
注释 ID
|
commentId | True | string |
注释 ID |
删除程序
删除程序。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
空间 ID
|
spaceId | True | string |
空间 ID |
|
程序 ID
|
programId | True | string |
程序 ID |
|
删除任务
|
deleteTasks | boolean |
同时删除关联的任务 |
返回
删除程序
删除一个或多个程序。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
空间 ID
|
spaceId | True | string |
空间 ID |
|
程序 ID
|
ids | True | array |
程序 ID 列表 |
|
删除任务
|
deleteTasks | boolean |
同时删除关联的任务 |
返回
删除请求
删除请求。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
空间 ID
|
spaceId | True | string |
空间 ID |
|
请求编号
|
requestId | True | string |
请求编号 |
删除请求
批量删除请求。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
空间 ID
|
spaceId | True | string |
空间 ID |
|
Content-Type
|
Content-Type | string |
Content-Type |
|
|
请求 ID
|
ids | array of string |
要删除的请求 ID 列表 |
返回
更新任务
更新现有任务。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
空间 ID
|
spaceId | True | string |
空间 ID |
|
任务 ID
|
taskId | True | string |
任务 ID |
|
被分配者 ID
|
assigneeId | string |
被分配者的用户 ID |
|
|
自定义属性 ID
|
id | string | ||
|
值 ID
|
id | string | ||
|
价值
|
value |
自定义属性值的值数据 |
||
|
Description
|
description | string |
任务说明 |
|
|
父 ID
|
parentId | string |
父任务的任务 ID |
|
|
计划工期
|
plannedDuration | integer |
计划工期（以天为单位） |
|
|
计划结束日期
|
plannedEndDate | date-time |
计划结束日期的日期字符串 |
|
|
计划开始日期
|
plannedStartDate | date-time |
计划开始日期的日期字符串 |
|
|
Priority
|
priority | string |
优先级值 |
|
|
程序 ID
|
programId | string |
任务所属的程序 ID |
|
|
步骤 ID
|
stepId | integer |
指示任务状态的步骤 ID |
|
|
Title
|
title | True | string |
任务标题 |
返回
- Body
- ProgramTask
更新注释
更新现有注释。 需要节点（程序、任务或请求）和注释 ID。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
空间 ID
|
spaceId | True | string |
空间 ID |
|
节点 ID
|
nodeId | True | string |
节点 ID |
|
注释 ID
|
commentId | True | string |
注释 ID |
|
批注有效负载
|
annotationPayload | string | ||
|
批注类型
|
annotationType | string | ||
|
注释内容
|
commentContent | True | string |
批注的内容 |
|
已解决
|
isResolved | boolean |
是否解析批注时为 True/false |
返回
- Body
- Comment
更新程序
更新并返回程序。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
空间 ID
|
spaceId | True | string |
空间 ID |
|
程序 ID
|
programId | True | string |
程序 ID |
|
阶段类型 ID
|
phaseTypeId | True | string |
阶段类型 ID |
|
空间 ID
|
spaceId | string |
空间 ID |
|
|
日期时间
|
datetime | date-time |
阶段的日期时间 |
|
|
Name
|
name | string |
阶段的名称 |
|
|
associatedToField
|
associatedToField | string |
阶段所关联的字段来自 PhaseType |
|
|
Description
|
description | string |
来自 PhaseType 的阶段的说明 |
|
|
颜色
|
color | string |
来自 PhaseType 的阶段的颜色 |
|
|
序号
|
ordinality | integer |
来自 PhaseType 的阶段顺序 |
|
|
已存档
|
archived | boolean |
指示程序是否已存档 |
|
|
已启用
|
enabled | boolean |
存档的已弃用指示器 |
|
|
隐藏提示
|
hideTips | boolean |
指示用户是否具有隐藏提示 |
|
|
启动日期
|
launchDate | date-time |
启动日期 |
|
|
类型
|
type | string |
访问群体对象的类型 |
|
|
ID
|
id | string |
受众 ID（用户组、用户等） |
|
|
跟踪
|
trackers | array of string |
关键字跟踪器列表 |
|
|
主题
|
topics | array of string |
关键字主题列表 |
|
|
程序类型
|
programType | string |
程序类型 |
|
|
第一个结果 KPI 指标
|
outcomeKpiFirst | string |
第一个结果 KPI 指标 |
|
|
第二个结果 KPI 指标
|
outcomeKpiSecond | string |
第二个结果 KPI 指标 |
|
|
第三个结果 KPI 指标
|
outcomeKpiThird | string |
第三个结果 KPI 指标 |
|
|
指标类型
|
metricType | string |
指标类型 |
|
|
目标值
|
targetValue | string |
用户为目标指定的数字目标值 |
|
|
度量单位
|
measuredIn | string |
设置指标度量方式的选项 |
|
|
趋势
|
trend | string |
设置跟踪目标趋势的选项 |
|
|
日期范围
|
dateRange | string |
为趋势设置的日期范围 |
|
|
隐藏概述
|
isHideFromOverView | boolean |
用于在概述页中隐藏指标目标的选项 |
|
|
Description
|
description | string |
关联说明 |
|
|
Name
|
name | string |
关联名称 |
|
|
节点 GUID
|
nodeGuid | string |
较长的 GUID 格式 |
|
|
节点 ID
|
nodeId | string |
节点 ID |
|
|
节点类型
|
nodeType | string |
关联的节点类型 |
|
|
空间 GUID
|
spaceGuid | string |
较长的 GUID 格式 |
|
|
空间 ID
|
spaceId | string |
空间 ID |
|
|
自定义属性 ID
|
id | string | ||
|
定位
|
localizations | object |
本地化对象 |
|
|
多个值
|
multipleValue | boolean |
指示自定义属性是否允许多个值 |
|
|
Name
|
name | string |
自定义属性的名称 |
|
|
值 ID
|
id | string | ||
|
价值
|
value |
自定义属性值的值数据 |
||
|
Description
|
description | string |
程序说明 |
|
|
处于活动状态
|
isActive | boolean |
指示程序是否处于活动状态？ |
|
|
管理器 ID
|
managerId | string |
项目经理的用户 ID |
|
|
计划工期
|
plannedDuration | integer |
计划工期（以天为单位） |
|
|
计划结束日期
|
plannedEndDate | date-time |
计划结束日期的日期字符串 |
|
|
计划开始日期
|
plannedStartDate | date-time |
计划开始日期的日期字符串 |
|
|
Title
|
title | True | string |
程序标题 |
返回
- Body
- Program
更新请求
更新请求。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
空间 ID
|
spaceId | True | string |
空间 ID |
|
请求编号
|
requestId | True | string |
请求编号 |
|
被分配者 ID
|
assigneeId | string |
被分配者的用户 ID |
|
|
内容 ID
|
contentId | uuid |
内容 ID |
|
|
DocCenter 完整路径
|
docCenterFullPath | string |
DocCenter 中存在内容的完整位置路径 |
|
|
主要版本
|
majorVersion | integer |
主版本数 |
|
|
次要版本
|
minorVersion | integer |
次要版本数 |
|
|
修改日期
|
modifiedDate | date-time |
上次更新内容引用的日期 |
|
|
订单编号
|
orderNo | integer |
指示订单的数字 |
|
|
配置文件 ID
|
profileId | uuid |
配置文件 ID |
|
|
配置文件版本 ID
|
profileVersionId | uuid |
配置文件的版本 ID |
|
|
来源
|
source | string |
内容源 |
|
|
TeamSite ID
|
teamSiteId | string |
TeamSite ID |
|
|
缩略图 ID
|
thumbnailId | string |
图像缩略图的 ID |
|
|
版本 ID
|
versionId | uuid |
内容的版本 ID |
|
|
自定义属性 ID
|
id | string | ||
|
值 ID
|
id | string | ||
|
价值
|
value |
自定义属性值的值数据 |
||
|
表单参考
|
formRef | True |
表单引用对象 |
|
|
注释
|
note | string |
用于有关状态更改的通知的注释 |
|
|
计划工期
|
plannedDuration | integer |
计划工期（以天为单位） |
|
|
计划结束日期
|
plannedEndDate | date-time |
计划结束日期的日期字符串（截止日期） |
|
|
计划开始日期
|
plannedStartDate | date-time |
计划开始日期的日期字符串 |
|
|
Priority
|
priority | string |
优先级值 |
|
|
程序 ID
|
programId | string |
请求所属的程序的程序 ID |
|
|
步骤 ID
|
stepId | True | integer |
指示状态的步骤 ID |
|
Title
|
title | True | string |
请求的标题 |
返回
- Body
- ProgramRequest
获取任务
按 ID 获取单个任务。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
空间 ID
|
spaceId | True | string |
空间 ID |
|
任务 ID
|
taskId | True | string |
任务 ID |
返回
- Body
- ProgramTask
获取任务
获取任务列表。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
空间 ID
|
spaceId | True | string |
空间 ID |
|
计划的结束日期
|
plannedEndDateFrom | date-time |
按任务截止日期（含）进行筛选 |
|
|
计划结束日期到
|
plannedEndDateTo | date-time |
按任务截止日期筛选（独占） |
|
|
计划的开始日期
|
plannedStartDateFrom | date-time |
按任务开始日期进行筛选（含） |
|
|
计划开始日期到
|
plannedStartDateTo | date-time |
按任务开始日期进行筛选（独占） |
|
|
创建自
|
createdAtFrom | date-time |
按任务创建日期进行筛选（含） |
|
|
创建时间到
|
createdAtTo | date-time |
按任务创建日期进行筛选（独占） |
|
|
在发件人处更新
|
updatedAtFrom | date-time |
按任务更新日期进行筛选（含） |
|
|
已更新到
|
updatedAtTo | date-time |
按任务更新日期进行筛选（独占） |
|
|
任务 ID
|
ids | array |
按任务 ID 列表进行筛选 |
|
|
Title
|
title | string |
按任务标题筛选 |
|
|
Description
|
description | string |
按任务说明进行筛选 |
|
|
被分配者 ID
|
assigneeIds | array |
要按被分配者筛选的用户 ID 的列表 |
|
|
优先 级
|
priorities | array |
按优先级列表进行筛选 |
|
|
关键字
|
keywords | string |
按关键字筛选 |
|
|
分配器 ID
|
assignerIds | array |
要按分配任务的用户筛选的用户 ID 的列表 |
|
|
步骤 ID
|
stepIds | array |
按状态值 ID 进行筛选 |
|
|
状态架构 ID
|
statusSchemaId | string |
按状态架构 ID 进行筛选 |
|
|
Cursor
|
cursor | string |
用于分页的游标 |
|
|
限度
|
limit | integer |
限制返回的记录数 |
|
|
排序
|
sort | array |
按查询排序 |
|
|
递归的
|
recursive | boolean |
在返回的列表中包括子任务 |
|
|
程序 ID
|
programId | string |
按程序 ID 进行筛选 |
|
|
具有计划
|
hasProgram | boolean |
按与程序关联的任务进行筛选 |
|
|
自定义属性
|
customProperties | string |
按自定义属性值进行筛选 |
|
|
追随者 ID
|
followerIds | array |
要按关注者筛选的用户 ID 列表 |
|
|
关联的节点 ID
|
associatedNodeIds | array |
要筛选的关联 ID 列表 |
|
|
创建者 ID
|
creatorIds | array |
要按创建者筛选的用户 ID 列表 |
|
|
包括关联
|
includeAssociations | boolean |
在响应中包含关联数据 |
|
|
父 ID
|
parentId | string |
要筛选的任务 ID 的列表 |
返回
获取批注
获取单个注释。 需要节点（程序、任务或请求）和注释 ID。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
空间 ID
|
spaceId | True | string |
空间 ID |
|
节点 ID
|
nodeId | True | string |
节点 ID |
|
注释 ID
|
commentId | True | string |
注释 ID |
返回
- Body
- Comment
获取批注
获取给定程序、任务或请求的所有注释。 需要节点（程序、任务或请求）ID。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
空间 ID
|
spaceId | True | string |
空间 ID |
|
节点 ID
|
nodeId | True | string |
节点 ID |
|
创建者 ID
|
creatorIds | array |
要按创建者查询的用户 ID 列表 |
|
|
Cursor
|
cursor | string |
用于分页的游标 |
|
|
限度
|
limit | integer |
用于限制记录的数字 |
|
|
排序
|
sort | array |
按查询排序 |
返回
- Body
- CommentQueryResponse
获取状态架构
按 ID 获取单个状态架构。 这些架构保存特定工作设置状态的数据。
示例： (Not started, In progress, Complete)
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
空间 ID
|
spaceId | True | string |
空间 ID |
|
状态架构 ID
|
statusSchemaId | True | string |
状态架构 ID |
返回
- Body
- StatusSchema
获取状态架构
获取任务/请求状态架构的列表。 这些架构保存特定工作设置状态的数据。
示例： (Not started, In progress, Complete)
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
空间 ID
|
spaceId | True | string |
空间 ID |
|
为默认值
|
isDefault | boolean |
获取默认状态架构 |
|
|
类型
|
type | string |
按节点类型查询 |
|
|
状态架构 ID
|
ids | array |
状态架构 ID 的列表 |
|
|
创建者 ID
|
creatorIds | array |
要按创建者查询的用户 ID 列表 |
|
|
Cursor
|
cursor | string |
用于分页的游标 |
|
|
限度
|
limit | integer |
限制返回的记录数 |
返回
获取程序
按 ID 获取单个程序。 如果需要，则返回任务。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
空间 ID
|
spaceId | True | string |
空间 ID |
|
程序 ID
|
programId | True | string |
程序 ID |
|
关联的节点深度
|
associatedNodesDepth | integer |
指示返回的关联节点数据的深度的数字 |
|
|
包括工作
|
includeWorks | boolean |
指示符以包含关联的任务数据 |
返回
- Body
- Program
获取程序
获取具有其属性和关联的程序的列表。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
空间 ID
|
spaceId | True | string |
空间 ID |
|
计划的结束日期
|
plannedEndDateFrom | date-time |
从计划的结束日期筛选 |
|
|
计划结束日期到
|
plannedEndDateTo | date-time |
筛选到计划的结束日期 |
|
|
计划的开始日期
|
plannedStartDateFrom | date-time |
从计划的开始日期进行筛选 |
|
|
计划开始日期到
|
plannedStartDateTo | date-time |
筛选为计划的开始日期 |
|
|
开始日期
|
launchDateFrom | date-time |
从启动日期筛选 |
|
|
启动日期到
|
launchDateTo | date-time |
筛选为启动日期 |
|
|
程序 ID
|
ids | array |
要查询的程序 ID 列表 |
|
|
程序标题
|
title | string |
要查询的程序标题 |
|
|
经理 ID
|
managerIds | array |
按管理器查询的用户 ID 列表 |
|
|
创建者 ID
|
creatorIds | array |
要按创建者查询的用户 ID 列表 |
|
|
关联的节点 ID
|
associatedNodeIds | array |
要查询的关联 ID 列表 |
|
|
Cursor
|
cursor | string |
用于分页的游标 |
|
|
限度
|
limit | integer |
限制返回的记录数 |
|
|
排序
|
sort | array |
排序查询 |
|
|
自定义属性
|
customProperties | string |
要查询的自定义属性列表 |
|
|
追随者 ID
|
followerIds | array |
要按关注者查询的用户 ID 列表 |
|
|
已存档
|
archived | boolean |
已存档或未存档程序的列表 |
|
|
观众
|
audience | array |
要查询的程序访问群体用户 ID 的列表 |
|
|
程序类型
|
programType | string |
要查询依据的 ProgramType 枚举 |
|
|
第一个结果 KPI 指标
|
outcomeKpiFirst | string |
要查询的第一个结果 KPI 指标枚举 |
|
|
第二个结果 KPI 指标
|
outcomeKpiSecond | string |
要查询的第二个结果 KPI 指标枚举 |
|
|
第三个结果 KPI 指标
|
outcomeKpiThird | string |
要查询的第三个结果 KPI 指标枚举 |
|
|
当前阶段
|
currentPhases | array |
要查询的当前阶段 ID 的列表 |
|
|
包括关联
|
includeAssociations | boolean |
允许包含关联数据的指示器 |
|
|
包括已存档
|
includeDeactivatedPrograms | boolean |
指示符，允许包含存档的程序（在启用时被忽略） |
|
|
包含页面
|
includePages | boolean |
允许包含页面数据的指示器 |
返回
- Body
- ProgramQueryResponse
获取请求
获取请求列表。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
空间 ID
|
spaceId | True | string |
空间 ID |
|
计划的结束日期
|
plannedEndDateFrom | date-time |
按请求截止日期进行筛选（含） |
|
|
计划结束日期到
|
plannedEndDateTo | date-time |
按请求截止日期（独占）进行筛选 |
|
|
计划的开始日期
|
plannedStartDateFrom | date-time |
按请求开始日期（含）进行筛选 |
|
|
计划开始日期到
|
plannedStartDateTo | date-time |
按请求开始日期（独占）进行筛选 |
|
|
创建自
|
createdAtFrom | date-time |
按请求创建日期进行筛选（含） |
|
|
创建时间到
|
createdAtTo | date-time |
按请求创建日期（独占）进行筛选 |
|
|
在发件人处更新
|
updatedAtFrom | date-time |
按请求更新日期进行筛选（含） |
|
|
已更新到
|
updatedAtTo | date-time |
按请求更新日期进行筛选（独占） |
|
|
请求 ID
|
ids | array |
请求 ID 的列表 |
|
|
Title
|
title | string |
搜索请求标题的关键字值 |
|
|
被分配者 ID
|
assigneeIds | array |
要筛选的被分配者的用户 ID 的列表 |
|
|
优先 级
|
priorities | array |
优先级值列表，可用值：关键值、高值、中值、低值 |
|
|
关键字
|
keywords | string |
要搜索的关键字值 |
|
|
分配器 ID
|
assignerIds | array |
要筛选的分配器用户 ID 的列表 |
|
|
创建者 ID
|
creatorIds | array |
要筛选的创建者的用户 ID 列表 |
|
|
步骤 ID
|
stepIds | array |
要筛选的步骤 ID 的列表 |
|
|
状态架构 ID
|
statusSchemaId | string |
要筛选依据的状态架构 ID |
|
|
Cursor
|
cursor | string |
用于指导下一页窗口的令牌 |
|
|
限度
|
limit | integer |
每页要返回的项目数，默认值：50 |
|
|
排序
|
sort | array |
按请求排序 |
|
|
程序 ID
|
programId | string |
请求关联的程序 ID |
|
|
具有计划
|
hasProgram | boolean |
按请求是否与程序关联进行筛选 |
|
|
自定义属性
|
customProperties | string |
按自定义属性进行筛选 |
|
|
追随者 ID
|
followerIds | array |
关注者用户 ID 的列表 |
|
|
关联的节点 ID
|
associatedNodeIds | array |
要筛选的关联节点 ID 的列表 |
|
|
内容引用对象
|
contentRefs | array |
内容引用对象列表 |
|
|
包括请求表单自定义属性
|
includeRequestFormCustomProperties | boolean |
是否包含请求表单自定义属性，默认值 false |
返回
触发器
| 任务创建时 |
触发以响应创建任务时 |
| 任务删除时 |
触发以响应删除任务时 |
| 任务更新时 |
触发以在更新任务时响应 |
| 创建程序时 |
触发以响应创建程序时 |
| 创建请求时 |
触发以响应创建请求时 |
| 删除程序时 |
触发以响应何时删除程序 |
| 删除请求时 |
触发以响应何时删除请求 |
| 更新程序时 |
用于在更新程序时响应的触发器 |
| 更新请求时 |
更新请求时要响应的触发器 |
任务创建时
触发以响应创建任务时
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
筛选器
|
filter | string |
示例：$.data..[?（@.id == 'foo'）]，基于 JsonPath 的筛选器表达式，请参阅 https://developer.seismic.com/seismicsoftware/docs/webhooksoverview#filtering-events 详细信息。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
id
|
id | uuid |
事件的唯一标识符。 |
|
版本
|
version | string |
事件的版本，例如“ProgramCreateV1”。 |
|
occurredAt
|
occurredAt | date-time |
发生 UTC 事件时的 ISO 8601 时间戳。 |
|
tenantId
|
tenantId | uuid |
租户的唯一标识符。 |
|
tenantName
|
tenantName | string |
租户的名称。 |
|
应用程序
|
application | string |
事件发起的应用程序。 |
|
productArea
|
productArea | string |
与事件相关的产品区域。 |
|
数据
|
data | TaskWebhookResponse |
任务删除时
触发以响应删除任务时
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
筛选器
|
filter | string |
示例：$.data..[?（@.id == 'foo'）]，基于 JsonPath 的筛选器表达式，请参阅 https://developer.seismic.com/seismicsoftware/docs/webhooksoverview#filtering-events 详细信息。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
id
|
id | uuid |
事件的唯一标识符。 |
|
版本
|
version | string |
事件的版本，例如“ProgramCreateV1”。 |
|
occurredAt
|
occurredAt | date-time |
发生 UTC 事件时的 ISO 8601 时间戳。 |
|
tenantId
|
tenantId | uuid |
租户的唯一标识符。 |
|
tenantName
|
tenantName | string |
租户的名称。 |
|
应用程序
|
application | string |
事件发起的应用程序。 |
|
productArea
|
productArea | string |
与事件相关的产品区域。 |
|
数据
|
data | TaskWebhookResponse |
任务更新时
触发以在更新任务时响应
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
筛选器
|
filter | string |
示例：$.data..[?（@.id == 'foo'）]，基于 JsonPath 的筛选器表达式，请参阅 https://developer.seismic.com/seismicsoftware/docs/webhooksoverview#filtering-events 详细信息。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
id
|
id | uuid |
事件的唯一标识符。 |
|
版本
|
version | string |
事件的版本，例如“ProgramCreateV1”。 |
|
occurredAt
|
occurredAt | date-time |
发生 UTC 事件时的 ISO 8601 时间戳。 |
|
tenantId
|
tenantId | uuid |
租户的唯一标识符。 |
|
tenantName
|
tenantName | string |
租户的名称。 |
|
应用程序
|
application | string |
事件发起的应用程序。 |
|
productArea
|
productArea | string |
与事件相关的产品区域。 |
|
数据
|
data | TaskWebhookResponse |
创建程序时
触发以响应创建程序时
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
筛选器
|
filter | string |
示例：$.data..[?（@.id == 'foo'）]，基于 JsonPath 的筛选器表达式，请参阅 https://developer.seismic.com/seismicsoftware/docs/webhooksoverview#filtering-events 详细信息。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
id
|
id | uuid |
事件的唯一标识符。 |
|
版本
|
version | string |
事件的版本，例如“ProgramCreateV1”。 |
|
occurredAt
|
occurredAt | date-time |
发生 UTC 事件时的 ISO 8601 时间戳。 |
|
tenantId
|
tenantId | uuid |
租户的唯一标识符。 |
|
tenantName
|
tenantName | string |
租户的名称。 |
|
应用程序
|
application | string |
事件发起的应用程序。 |
|
productArea
|
productArea | string |
与事件相关的产品区域。 |
|
数据
|
data | ProgramWebhookResponse |
数据 |
创建请求时
触发以响应创建请求时
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
筛选器
|
filter | string |
示例：$.data..[?（@.id == 'foo'）]，基于 JsonPath 的筛选器表达式，请参阅 https://developer.seismic.com/seismicsoftware/docs/webhooksoverview#filtering-events 详细信息。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
id
|
id | uuid |
事件的唯一标识符。 |
|
版本
|
version | string |
事件的版本，例如“ProgramCreateV1”。 |
|
occurredAt
|
occurredAt | date-time |
发生 UTC 事件时的 ISO 8601 时间戳。 |
|
tenantId
|
tenantId | uuid |
租户的唯一标识符。 |
|
tenantName
|
tenantName | string |
租户的名称。 |
|
应用程序
|
application | string |
事件发起的应用程序。 |
|
productArea
|
productArea | string |
与事件相关的产品区域。 |
|
数据
|
data | RequestWebhookResponse |
删除程序时
触发以响应何时删除程序
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
筛选器
|
filter | string |
示例：$.data..[?（@.id == 'foo'）]，基于 JsonPath 的筛选器表达式，请参阅 https://developer.seismic.com/seismicsoftware/docs/webhooksoverview#filtering-events 详细信息。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
id
|
id | uuid |
事件的唯一标识符。 |
|
版本
|
version | string |
事件的版本，例如“ProgramCreateV1”。 |
|
occurredAt
|
occurredAt | date-time |
发生 UTC 事件时的 ISO 8601 时间戳。 |
|
tenantId
|
tenantId | uuid |
租户的唯一标识符。 |
|
tenantName
|
tenantName | string |
租户的名称。 |
|
应用程序
|
application | string |
事件发起的应用程序。 |
|
productArea
|
productArea | string |
与事件相关的产品区域。 |
|
数据
|
data | ProgramWebhookResponse |
数据 |
删除请求时
触发以响应何时删除请求
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
筛选器
|
filter | string |
示例：$.data..[?（@.id == 'foo'）]，基于 JsonPath 的筛选器表达式，请参阅 https://developer.seismic.com/seismicsoftware/docs/webhooksoverview#filtering-events 详细信息。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
id
|
id | uuid |
事件的唯一标识符。 |
|
版本
|
version | string |
事件的版本，例如“ProgramCreateV1”。 |
|
occurredAt
|
occurredAt | date-time |
发生 UTC 事件时的 ISO 8601 时间戳。 |
|
tenantId
|
tenantId | uuid |
租户的唯一标识符。 |
|
tenantName
|
tenantName | string |
租户的名称。 |
|
应用程序
|
application | string |
事件发起的应用程序。 |
|
productArea
|
productArea | string |
与事件相关的产品区域。 |
|
数据
|
data | RequestWebhookResponse |
更新程序时
用于在更新程序时响应的触发器
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
筛选器
|
filter | string |
示例：$.data..[?（@.id == 'foo'）]，基于 JsonPath 的筛选器表达式，请参阅 https://developer.seismic.com/seismicsoftware/docs/webhooksoverview#filtering-events 详细信息。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
id
|
id | uuid |
事件的唯一标识符。 |
|
版本
|
version | string |
事件的版本，例如“ProgramCreateV1”。 |
|
occurredAt
|
occurredAt | date-time |
发生 UTC 事件时的 ISO 8601 时间戳。 |
|
tenantId
|
tenantId | uuid |
租户的唯一标识符。 |
|
tenantName
|
tenantName | string |
租户的名称。 |
|
应用程序
|
application | string |
事件发起的应用程序。 |
|
productArea
|
productArea | string |
与事件相关的产品区域。 |
|
数据
|
data | ProgramWebhookResponse |
数据 |
更新请求时
更新请求时要响应的触发器
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
筛选器
|
filter | string |
示例：$.data..[?（@.id == 'foo'）]，基于 JsonPath 的筛选器表达式，请参阅 https://developer.seismic.com/seismicsoftware/docs/webhooksoverview#filtering-events 详细信息。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
id
|
id | uuid |
事件的唯一标识符。 |
|
版本
|
version | string |
事件的版本，例如“ProgramCreateV1”。 |
|
occurredAt
|
occurredAt | date-time |
发生 UTC 事件时的 ISO 8601 时间戳。 |
|
tenantId
|
tenantId | uuid |
租户的唯一标识符。 |
|
tenantName
|
tenantName | string |
租户的名称。 |
|
应用程序
|
application | string |
事件发起的应用程序。 |
|
productArea
|
productArea | string |
与事件相关的产品区域。 |
|
数据
|
data | RequestWebhookResponse |
定义
关联
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Description
|
description | string |
关联说明 |
|
Name
|
name | string |
关联名称 |
|
节点 GUID
|
nodeGuid | string |
较长的 GUID 格式 |
|
节点 ID
|
nodeId | string |
节点 ID |
|
节点类型
|
nodeType | string |
关联的节点类型 |
|
空间 GUID
|
spaceGuid | string |
较长的 GUID 格式 |
|
空间 ID
|
spaceId | string |
空间 ID |
AsyncOperationResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
异步作 ID
|
asyncOperationIds | array of string |
异步作 ID 的列表 |
观众
Audience 对象
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
类型
|
type | string |
访问群体对象的类型 |
|
ID
|
id | string |
受众 ID（用户组、用户等） |
注释
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
批注有效负载
|
annotationPayload | string | |
|
批注类型
|
annotationType | string | |
|
注释内容
|
commentContent | string | |
|
创建时间
|
createdAt | date-time |
创建的日期字符串 |
|
创建者 ID
|
creatorId | string |
创建者的用户 ID |
|
注释 ID
|
id | string |
注释 ID |
|
已解决
|
isResolved | boolean |
是否解析批注时为 True/false |
|
节点 ID
|
nodeId | string |
节点 ID |
|
节点类型
|
nodeType | string |
注释的节点类型 |
|
页面索引
|
pageIndex | string |
编号页索引 |
|
父 ID
|
parentId | string |
父注释 ID |
|
回复计数
|
replyCount | integer |
回复数量 |
|
空间 ID
|
spaceId | string |
空间 ID |
|
已更新时间
|
updatedAt | date-time |
更新日期的日期字符串 |
CommentQueryResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
计数
|
count | integer |
返回的记录数 |
|
Cursor
|
cursor | string |
用于分页的游标 |
|
物品
|
items | array of Comment |
响应中的项列表 |
|
限度
|
limit | integer |
用于限制记录的数字 |
|
元数据对象
|
meta | Meta |
元数据对象 |
ContentRef
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
内容 ID
|
contentId | uuid |
内容 ID |
|
DocCenter 完整路径
|
docCenterFullPath | string |
DocCenter 中存在内容的完整位置路径 |
|
主要版本
|
majorVersion | integer |
主版本数 |
|
次要版本
|
minorVersion | integer |
次要版本数 |
|
修改日期
|
modifiedDate | date-time |
上次更新内容引用的日期 |
|
订单编号
|
orderNo | integer |
指示订单的数字 |
|
配置文件 ID
|
profileId | uuid |
配置文件 ID |
|
配置文件版本 ID
|
profileVersionId | uuid |
配置文件的版本 ID |
|
来源
|
source | string |
内容源 |
|
TeamSite ID
|
teamSiteId | string |
TeamSite ID |
|
缩略图 ID
|
thumbnailId | string |
图像缩略图的 ID |
|
版本 ID
|
versionId | uuid |
内容的版本 ID |
CustomProperty
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
允许多个值
|
allowMultipleValues | boolean |
指示自定义属性是否允许多个值 |
|
按 ID 创建
|
createdById | string |
创建者的用户 ID |
|
具有值的域
|
hasDomainOfValues | boolean |
指示自定义属性是否具有可能的值 |
|
Hint
|
hint | string |
描述自定义属性名称下显示的提示的值 |
|
自定义属性 ID
|
id | string | |
|
必需
|
isRequired | boolean |
指示是否需要自定义属性 |
|
上次修改者 ID
|
lastModifiedById | string |
上次更新自定义属性的用户的用户 ID |
|
Name
|
name | string |
自定义属性的名称 |
|
作设置
|
operationSetting | string |
描述自定义属性上不同作设置的对象 |
|
下单
|
order | integer |
指示自定义属性列表中的顺序的数字 |
|
可能的值
|
possibleValues | array of PossibleValuesItem |
自定义属性的可能值列表（如果适用） |
|
范围设置
|
scopeSettings | array of ScopeSettingsItemDefinition |
描述自定义属性上不同范围的设置的对象 |
|
Scopes
|
scopes | array of string |
范围列表 |
|
值架构名称
|
valueSchemaName | string |
自定义属性值架构的名称 |
|
valueSchemaProperty
|
valueSchemaProperty | ValueSchemaPropertyDefinition |
值架构定义 |
|
值类型
|
valueType | string |
自定义属性值的类型 |
CustomPropertyValues
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
自定义属性 ID
|
id | string | |
|
定位
|
localizations | object |
本地化对象 |
|
多个值
|
multipleValue | boolean |
指示自定义属性是否允许多个值 |
|
Name
|
name | string |
自定义属性的名称 |
|
价值观
|
values | array of CustomPropertyValuesValues |
自定义属性值列表 |
CustomPropertyValuesValues
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
值 ID
|
id | string | |
|
价值
|
value |
自定义属性值的值数据 |
关注者
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
用户/用户组 ID
|
id | string |
关注者的用户/用户组 ID |
|
类型
|
type | string |
用户或用户组关注者类型 |
Meta
元数据对象
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
计数
|
count | integer |
返回的记录数 |
|
Query
|
query | array of MetaQueryInfo |
查询对象 |
MetaQueryInfo
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
排序
|
sort | array of string |
排序查询 |
MetricObjective
指标目标对象
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
指标类型
|
metricType | string |
指标类型 |
|
目标值
|
targetValue | string |
用户为目标指定的数字目标值 |
|
度量单位
|
measuredIn | string |
设置指标度量方式的选项 |
|
趋势
|
trend | string |
设置跟踪目标趋势的选项 |
|
日期范围
|
dateRange | string |
为趋势设置的日期范围 |
|
隐藏概述
|
isHideFromOverView | boolean |
用于在概述页中隐藏指标目标的选项 |
阶段
计划阶段
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
阶段类型 ID
|
phaseTypeId | string |
阶段类型 ID |
|
空间 ID
|
spaceId | string |
空间 ID |
|
日期时间
|
datetime | date-time |
阶段的日期时间 |
|
Name
|
name | string |
阶段的名称 |
|
associatedToField
|
associatedToField | string |
阶段所关联的字段来自 PhaseType |
|
Description
|
description | string |
来自 PhaseType 的阶段的说明 |
|
颜色
|
color | string |
来自 PhaseType 的阶段的颜色 |
|
序号
|
ordinality | integer |
来自 PhaseType 的阶段顺序 |
Program
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
实际工期
|
actualDuration | integer |
计算的实际工期（以天为单位） |
|
实际结束日期
|
actualEndDate | date-time |
从程序实际结束的计算结束日期 |
|
实际开始日期
|
actualStartDate | date-time |
从实际启动程序开始计算的开始日期 |
|
分析设置
|
analyticSetting | ProgramAnalyticSetting | |
|
关联的节点
|
associatedNodes | array of ProgramAssociatedNodes |
关联数据列表 |
|
协会
|
associations | array of Association |
关联列表（库内容） |
|
复制自
|
copyFrom | string |
从中复制程序的程序 ID |
|
创建时间
|
createdAt | date-time |
创建日期的日期字符串 |
|
创建者 ID
|
creatorId | string |
创建者的用户 ID |
|
自定义属性
|
customProperties | array of CustomPropertyValues |
自定义属性列表 |
|
简要说明
|
description | string |
程序的简要说明 |
|
关注者
|
followers | array of Follower |
关注者列表 |
|
程序 ID
|
id | string | |
|
处于活动状态
|
isActive | boolean |
指示程序是否处于活动状态 |
|
是模板
|
isTemplate | boolean |
指示程序是否为模板 |
|
管理器 ID
|
managerId | string |
项目经理的用户 ID |
|
最大排名
|
maxRank | string |
最大排名编号 |
|
最小排名
|
minRank | string |
最小排名编号 |
|
计划工期
|
plannedDuration | integer |
计划工期（以天为单位） |
|
计划结束日期
|
plannedEndDate | date-time |
计划结束日期的日期字符串 |
|
计划开始日期
|
plannedStartDate | date-time |
计划开始日期的日期字符串 |
|
空间 ID
|
spaceId | string | |
|
模板编号
|
templateId | string |
从中创建了程序的模板 ID |
|
Title
|
title | string |
程序标题 |
|
已更新时间
|
updatedAt | date-time |
上次更新日期程序 |
|
工程
|
works | array of ProgramTask |
任务和请求列表 |
ProgramAnalyticSetting
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
阶段
|
currentPhase | Phase |
计划阶段 |
|
阶段
|
phases | array of Phase |
可能的程序阶段列表 |
|
已存档
|
archived | boolean |
指示程序是否已存档 |
|
已启用
|
enabled | boolean |
存档的已弃用指示器 |
|
隐藏提示
|
hideTips | boolean |
指示用户是否具有隐藏提示 |
|
启动日期
|
launchDate | date-time |
启动日期 |
|
观众
|
audience | array of Audience |
节目受众的用户组列表 |
|
跟踪
|
trackers | array of string |
关键字跟踪器列表 |
|
主题
|
topics | array of string |
关键字主题列表 |
|
程序类型
|
programType | string |
程序类型 |
|
第一个结果 KPI 指标
|
outcomeKpiFirst | string |
第一个结果 KPI 指标 |
|
第二个结果 KPI 指标
|
outcomeKpiSecond | string |
第二个结果 KPI 指标 |
|
第三个结果 KPI 指标
|
outcomeKpiThird | string |
第三个结果 KPI 指标 |
|
指标目标
|
metricObjectives | array of MetricObjective |
指标目标列表 |
ProgramQueryResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
计数
|
count | integer |
返回的记录数 |
|
Cursor
|
cursor | string |
用于分页的游标 |
|
程序对象
|
items | array of Program |
响应中的程序项列表 |
|
限度
|
limit | integer |
用于限制记录的数字 |
|
元数据对象
|
meta | Meta |
元数据对象 |
ProgramWebhookResponse
数据
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
tenantId
|
tenantId | string |
data/tenantId |
|
tenantName
|
tenantName | string |
data/tenantName |
|
actorId
|
actorId | string |
data/actorId |
|
事件时间戳
|
eventTimestamp | integer |
data/eventTimestamp |
|
programId
|
programId | string |
data/programId |
|
title
|
title | string |
data/title |
|
描述
|
description | string |
data/description |
|
plannedStartDate
|
plannedStartDate | date-time |
data/plannedStartDate |
|
plannedEndDate
|
plannedEndDate | date-time |
data/plannedEndDate |
|
plannedDuration
|
plannedDuration | integer |
data/plannedDuration |
|
creatorId
|
creatorId | string |
data/creatorId |
|
createdAt
|
createdAt | date-time |
data/createdAt |
|
attachedContent
|
attachedContent | array of object |
attachedContent |
|
spaceId
|
attachedContent.spaceId | string |
data/attachedContent/spaceId |
|
contentId
|
attachedContent.contentId | string |
data/attachedContent/contentId |
|
attachedRequests
|
attachedRequests | array of object |
attachedRequests |
|
spaceId
|
attachedRequests.spaceId | string |
data/attachedRequests/spaceId |
|
requestId
|
attachedRequests.requestId | string |
data/attachedRequests/requestId |
|
attachedTasks
|
attachedTasks | array of object |
attachedTasks |
|
spaceId
|
attachedTasks.spaceId | string |
data/attachedTasks/spaceId |
|
taskId
|
attachedTasks.taskId | string |
data/attachedTasks/taskId |
|
managerId
|
managerId | string |
data/managerId |
|
isTemplate
|
isTemplate | boolean |
data/isTemplate |
|
updatedAt
|
updatedAt | date-time |
data/updatedAt |
|
actualDuration
|
actualDuration | integer |
data/actualDuration |
|
actualStartDate
|
actualStartDate | date-time |
data/actualStartDate |
|
actualEndDate
|
actualEndDate | date-time |
data/actualEndDate |
|
copyFrom
|
copyFrom | string |
data/copyFrom |
|
追随 者
|
followers | array of object |
追随 者 |
|
userId
|
followers.userId | string |
userId |
|
spaceId
|
spaceId | string |
data/spaceId |
|
模板ID
|
templateId | string |
data/templateId |
|
updateDiffs
|
updateDiffs | array of object | |
|
字段名称
|
updateDiffs.fieldName | string |
data/updateDiffs/fieldName |
|
before
|
updateDiffs.before | string |
data/updateDiffs/before |
|
after
|
updateDiffs.after | string |
data/updateDiffs/after |
|
分析设置
|
analyticSetting | ProgramAnalyticSetting | |
|
customProperties
|
customProperties | array of object | |
|
id
|
customProperties.id | string |
data/customProperties/id |
|
multipleValue
|
customProperties.multipleValue | boolean |
data/customProperties/multipleValue |
|
姓名
|
customProperties.name | string |
data/customProperties/name |
|
customProperties
|
customProperties.customProperties | array of object | |
|
id
|
customProperties.customProperties.id | string |
data/customProperties/customProperties/id |
|
value
|
customProperties.customProperties.value | string |
data/customProperties/customProperties/value |
|
类型
|
customProperties.customProperties.type | string |
data/customProperties/customProperties/type |
ProgramRequest
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
被分配者 ID
|
assigneeId | string |
被分配者的用户 ID |
|
分配器 ID
|
assignerId | string |
分配者的用户 ID |
|
协会
|
associations | array of Association |
关联列表（库内容） |
|
内容引用对象
|
contentRefs | array of ContentRef |
内容引用列表（WorkSpace 和 DocCenter 内容） |
|
创建时间
|
createdAt | date-time |
创建日期的日期字符串 |
|
创建者 ID
|
creatorId | string |
创建者的用户 ID |
|
自定义属性
|
customProperties | array of CustomPropertyValues |
自定义属性列表 |
|
关注者
|
followers | array of Follower |
关注者列表 |
|
表单 Ref
|
formRef |
表单引用对象 |
|
|
请求编号
|
id | string | |
|
注释
|
note | string |
有关状态更改的通知的说明 |
|
计划工期
|
plannedDuration | integer |
计划工期（以天为单位） |
|
计划结束日期
|
plannedEndDate | date-time |
计划结束日期的日期字符串 |
|
计划开始日期
|
plannedStartDate | date-time |
计划开始日期的日期字符串 |
|
Priority
|
priority | string |
优先级值 |
|
程序 ID
|
programId | string |
请求与 |
|
等级
|
rank | string |
请求列表中的请求排名 |
|
requestFormCustomPropertyOption
|
requestFormCustomPropertyOption | RequestFormCustomProperties |
请求表单自定义属性 |
|
空间 ID
|
spaceId | string | |
|
状态架构 ID
|
statusSchemaId | string | |
|
步骤 ID
|
stepId | integer |
指示状态值的步骤 ID |
|
Title
|
title | string |
请求的标题 |
|
已更新时间
|
updatedAt | date-time |
上次更新请求的日期 |
ProgramRequestQueryResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
计数
|
count | integer |
返回的记录数 |
|
Cursor
|
cursor | string |
用于分页的游标 |
|
请求对象
|
items | array of ProgramRequest |
响应中的请求对象列表 |
|
限度
|
limit | integer |
用于限制记录的数字 |
|
元数据对象
|
meta | Meta |
元数据对象 |
PlannerSubTask
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
实际工期
|
actualDuration | integer |
计算的实际工期（以天为单位） |
|
实际结束日期
|
actualEndDate | date-time |
任务的工时完成日期 |
|
实际开始日期
|
actualStartDate | date-time |
任务工作开始的日期 |
|
被分配者 ID
|
assigneeId | string |
被分配者的用户 ID |
|
分配器 ID
|
assignerId | string |
要添加被分配者的最后一个用户的用户 ID |
|
协会
|
associations | array of Association |
任务关联列表 |
|
复制自
|
copyFrom | string |
从中复制任务的任务 ID |
|
创建时间
|
createdAt | date-time |
创建任务的日期 |
|
创建者 ID
|
creatorId | string |
创建者的用户 ID |
|
自定义属性
|
customProperties | array of CustomPropertyValues |
任务上的自定义属性列表 |
|
Description
|
description | string |
任务说明 |
|
关注者
|
followers | array of Follower |
任务上的关注者列表 |
|
任务 ID
|
id | string | |
|
是模板
|
isTemplate | boolean |
指示任务是否是模板的一部分 |
|
最大排名
|
maxRank | string |
最大排名 |
|
最小排名
|
minRank | string |
最低排名 |
|
父 ID
|
parentId | string |
如果任务是子任务，则父任务的任务 ID |
|
计划工期
|
plannedDuration | integer |
计划工期（以天为单位） |
|
计划结束日期
|
plannedEndDate | date-time |
结束日期的日期字符串（截止日期） |
|
计划开始日期
|
plannedStartDate | date-time |
开始日期的日期字符串 |
|
Priority
|
priority | string |
优先级值 |
|
程序 ID
|
programId | string |
任务所属的程序 ID |
|
等级
|
rank | string |
任务列表中的任务排名 |
|
空间 ID
|
spaceId | string | |
|
状态架构 ID
|
statusSchemaId | string | |
|
步骤 ID
|
stepId | integer |
状态架构中的步骤 ID |
|
模板编号
|
templateId | string |
任务所属的模板的模板 ID |
|
Title
|
title | string |
任务标题 |
|
类型
|
type | string |
任务类型 |
|
更新时间
|
updatedAt | date-time |
上次更新任务的日期 |
ProgramTask
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
实际工期
|
actualDuration | integer |
计算的实际工期（以天为单位） |
|
实际结束日期
|
actualEndDate | date-time |
任务的工时完成日期 |
|
实际开始日期
|
actualStartDate | date-time |
任务工作开始的日期 |
|
分配 ID
|
assigneeId | string |
被分配者的用户 ID |
|
分配器 ID
|
assignerId | string |
要添加被分配者的最后一个用户的用户 ID |
|
协会
|
associations | array of Association |
任务关联列表 |
|
复制自
|
copyFrom | string |
从中复制任务的任务 ID |
|
创建时间
|
createdAt | date-time |
创建任务的日期 |
|
创建者 ID
|
creatorId | string |
创建者的用户 ID |
|
自定义属性
|
customProperties | array of CustomPropertyValues |
任务上的自定义属性列表 |
|
Description
|
description | string |
任务说明 |
|
关注者
|
followers | array of Follower |
任务上的关注者列表 |
|
任务 ID
|
id | string | |
|
是模板
|
isTemplate | boolean |
指示任务是否是模板的一部分 |
|
最大排名
|
maxRank | string |
最大排名 |
|
最小排名
|
minRank | string |
最低排名 |
|
父 ID
|
parentId | string |
如果任务是子任务，则父任务的任务 ID |
|
计划工期
|
plannedDuration | integer |
计划工期（以天为单位） |
|
计划结束日期
|
plannedEndDate | date-time |
计划结束日期的日期字符串（截止日期） |
|
计划开始日期
|
plannedStartDate | date-time |
计划开始日期的日期字符串 |
|
Priority
|
priority | string |
优先级值 |
|
程序 ID
|
programId | string |
任务所属的程序 ID |
|
等级
|
rank | string |
任务列表中的任务排名 |
|
空间 ID
|
spaceId | string | |
|
状态架构 ID
|
statusSchemaId | string | |
|
步骤 ID
|
stepId | integer |
状态架构中的步骤 ID |
|
子任务 ID
|
subTaskIds | array of string |
子任务 ID 列表 |
|
子任务
|
subTasks | array of PlannerSubTask |
任务上的子任务列表 |
|
模板编号
|
templateId | string |
任务所属的模板的模板 ID |
|
Title
|
title | string |
任务标题 |
|
类型
|
type | string |
任务类型 |
|
已更新时间
|
updatedAt | date-time |
上次更新任务的日期 |
ProgramTaskQueryResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
计数
|
count | integer |
返回的记录数 |
|
Cursor
|
cursor | string |
用于分页的游标 |
|
任务对象
|
items | array of ProgramTask |
响应中的任务对象列表 |
|
限度
|
limit | integer |
用于限制记录的数字 |
|
元数据对象
|
meta | Meta |
元数据对象 |
PossibleValuesItem
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
值 ID
|
id | string | |
|
下单
|
order | integer |
指示订单的数字 |
|
价值
|
value |
实际值数据 |
ProgramAssociatedNodes
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
节点 ID
|
nodeId | string | |
|
节点类型
|
nodeType | string |
关联的节点类型 |
|
空间 ID
|
spaceId | string |
RequestFormCustomProperties
请求表单自定义属性
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
创建时间
|
createdAt | date-time |
创建日期的日期字符串 |
|
自定义属性
|
customProperties | array of CustomProperty |
自定义属性列表 |
RequestWebhookResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
id
|
id | string |
data/id |
|
tenantId
|
tenantId | string |
data/tenantId |
|
tenantName
|
tenantName | string |
data/tenantName |
|
requestId
|
requestId | string |
data/requestId |
|
事件时间戳
|
eventTimestamp | integer |
data/eventTimestamp |
|
actorId
|
actorId | string |
data/actorId |
|
spaceId
|
spaceId | string |
data/spaceId |
|
title
|
title | string |
data/title |
|
assigneeId
|
assigneeId | string |
data/assigneeId |
|
assignerId
|
assignerId | string |
data/assignerId |
|
creatorId
|
creatorId | string |
data/creatorId |
|
plannedStartDate
|
plannedStartDate | date-time |
data/plannedStartDate |
|
plannedEndDate
|
plannedEndDate | date-time |
data/plannedEndDate |
|
plannedDuration
|
plannedDuration | integer |
data/plannedDuration |
|
createdAt
|
createdAt | date-time |
data/createdAt |
|
updatedAt
|
updatedAt | date-time |
data/updatedAt |
|
状态
|
status | string |
data/status |
|
priority
|
priority | string |
data/priority |
|
programId
|
programId | string |
data/programId |
|
注意
|
note | string |
data/note |
|
formId
|
formRef.formId | string |
data/formRef/formId |
|
minorVersion
|
formRef.minorVersion | integer |
data/formRef/minorVersion |
|
majorVersion
|
formRef.majorVersion | integer |
data/formRef/majorVersion |
|
追随 者
|
followers | array of object |
追随 者 |
|
userId
|
followers.userId | string |
userId |
|
attachedContent
|
attachedContent | array of object |
attachedContent |
|
spaceId
|
attachedContent.spaceId | string |
data/attachedContent/spaceId |
|
contentId
|
attachedContent.contentId | string |
data/attachedContent/contentId |
|
updateDiffs
|
updateDiffs | array of object |
data/updateDiffs |
|
字段名称
|
updateDiffs.fieldName | string |
data/updateDiffs/fieldName |
|
before
|
updateDiffs.before | string |
data/updateDiffs/before |
|
after
|
updateDiffs.after | string |
data/updateDiffs/after |
|
customProperties
|
customProperties | array of object |
数据 |
|
id
|
customProperties.id | string |
data/customProperties/id |
|
multipleValue
|
customProperties.multipleValue | boolean |
data/customProperties/multipleValue |
|
姓名
|
customProperties.name | string |
data/customProperties/name |
|
customProperties
|
customProperties.customProperties | array of object |
customProperties |
|
id
|
customProperties.customProperties.id | string |
data/customProperties/customProperties/id |
|
value
|
customProperties.customProperties.value | string |
data/customProperties/customProperties/value |
|
类型
|
customProperties.customProperties.type | string |
data/customProperties/customProperties/type |
ScopeSettingsItemDefinition
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
必需
|
isRequired | boolean |
指示字段是否是必需的 |
|
Scope
|
scope | string |
自定义属性定义所属的节点类型的类型列表 |
StatusSchema
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
创建时间
|
createdAt | date-time |
创建日期的日期字符串 |
|
创建者 ID
|
creatorId | string |
创建者的用户 ID |
|
状态架构 ID
|
id | string | |
|
为默认值
|
isDefault | boolean |
指示状态架构是否为默认架构 |
|
Name
|
name | string |
状态架构的名称 |
|
空间 ID
|
spaceId | string | |
|
Steps
|
steps | array of string |
步骤列表及其值 |
|
转换
|
transitions | array of array |
转换规则列表 |
|
items
|
transitions | array of integer | |
|
类型
|
type | string |
可用于状态架构的节点类型 |
|
已更新时间
|
updatedAt | date-time |
上次更新状态架构的日期 |
StatusSchemaQueryResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
计数
|
count | integer |
返回的记录数 |
|
Cursor
|
cursor | string |
用于分页的游标 |
|
状态架构对象
|
items | array of StatusSchema |
响应中的状态架构对象列表 |
|
限度
|
limit | integer |
用于限制记录的数字 |
|
元数据对象
|
meta | Meta |
元数据对象 |
TaskWebhookResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
id
|
id | string |
data/id |
|
tenantId
|
tenantId | string |
data/tenantId |
|
tenantName
|
tenantName | string |
data/tenantName |
|
taskId
|
taskId | string |
data/taskId |
|
事件时间戳
|
eventTimestamp | integer |
data/eventTimestamp |
|
actorId
|
actorId | string |
data/actorId |
|
spaceId
|
spaceId | string |
data/spaceId |
|
title
|
title | string |
data/title |
|
描述
|
description | string |
data/description |
|
assigneeId
|
assigneeId | string |
data/assigneeId |
|
assignerId
|
assignerId | string |
data/assignerId |
|
creatorId
|
creatorId | string |
data/creatorId |
|
plannedStartDate
|
plannedStartDate | date-time |
data/plannedStartDate |
|
plannedEndDate
|
plannedEndDate | date-time |
data/plannedEndDate |
|
plannedDuration
|
plannedDuration | integer |
data/plannedDuration |
|
actualStartDate
|
actualStartDate | date-time |
data/actualStartDate |
|
actualEndDate
|
actualEndDate | date-time |
data/actualEndDate |
|
actualDuration
|
actualDuration | integer |
data/actualDuration |
|
createdAt
|
createdAt | date-time |
data/createdAt |
|
updatedAt
|
updatedAt | date-time |
data/updatedAt |
|
状态
|
status | string |
data/status |
|
priority
|
priority | string |
data/priority |
|
parentId
|
parentId | string |
data/parentId |
|
programId
|
programId | string |
data/programId |
|
copyFrom
|
copyFrom | string |
data/copyFrom |
|
追随 者
|
followers | array of object |
追随 者 |
|
userId
|
followers.userId | string |
userId |
|
模板ID
|
templateId | string |
data/templateId |
|
attachedContent
|
attachedContent | array of object |
attachedContent |
|
spaceId
|
attachedContent.spaceId | string |
data/attachedContent/spaceId |
|
contentId
|
attachedContent.contentId | string |
data/attachedContent/contentId |
|
attachedSubTasks
|
attachedSubTasks | array of object |
attachedSubTasks |
|
spaceId
|
attachedSubTasks.spaceId | string |
data/attachedSubTasks/spaceId |
|
taskId
|
attachedSubTasks.taskId | string |
data/attachedSubTasks/taskId |
|
updateDiffs
|
updateDiffs | array of object | |
|
字段名称
|
updateDiffs.fieldName | string |
data/updateDiffs/fieldName |
|
before
|
updateDiffs.before | string |
data/updateDiffs/before |
|
after
|
updateDiffs.after | string |
data/updateDiffs/after |
|
customProperties
|
customProperties | array of object |
数据 |
|
id
|
customProperties.id | string |
data/customProperties/id |
|
multipleValue
|
customProperties.multipleValue | boolean |
data/customProperties/multipleValue |
|
姓名
|
customProperties.name | string |
data/customProperties/name |
|
customProperties
|
customProperties.customProperties | array of object |
customProperties |
|
id
|
customProperties.customProperties.id | string |
data/customProperties/customProperties/id |
|
value
|
customProperties.customProperties.value | string |
data/customProperties/customProperties/value |
|
类型
|
customProperties.customProperties.type | string |
data/customProperties/customProperties/type |
ValueSchemaPropertyDefinition
值架构定义
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
最大数量
|
max | string | |
|
最小数字
|
min | string |