本文中的命令与 Workiva Chains 连接器一起使用。要查找您的链 ID，请参阅 这篇关于在Workiva中查找 ID 的文章。
Workiva REST API 连接器
除非另有说明，否则请将值设置为与您的 Appspot 匹配。
| 输入 | 类型 | AppSpot | 细节 |
| 基本 URL | 文本框 | 产品（美国） | https://h.app.wdesk.com/s/wdata/oc/api/ |
| 基本 URL | 文本框 | 欧盟产品 | https://h.eu.wdesk.com/s/wdata/oc/api/ |
| 基本 URL | 文本框 | 亚太地区产品 | https://h.apac.wdesk.com/s/wdata/oc/api/ |
执行链
执行一个链式操作并等待其完成。
等效 API 调用: https://developers.workiva.com/chains-v1/chains-startchain/
注：虽然在需要动态链 ID 时可以使用此命令，但我们建议在大多数情况下使用 运行链事件 。Run Chain 事件与正在执行的链更紧密地联系在一起，并提供更简单的用户体验。
输入
| 输入 | 类型 | 细节 |
| 环境 ID | 文本框 | 环境的ID。 |
| 链 ID | 文本框 | 链的ID。 |
| 运行时变量 | 组字段 | 链中使用的运行时变量的值。 |
| 轮询间隔 | 数字字段 | 可选: 在检查链是否已完成之前等待的时间（以秒为单位）。默认值为五秒，只有当您预计链条会长时间运行时才应进行调整。 |
输出
| 输出 | 输出类型 |
| 连锁跑 | 文件 |
退出代码
| 退出代码 | 类型 | 细节 |
| 0 | 成功 | 成功 |
| 1 | 错误 | 普遍失败 |
| 2 | 错误 | 身份验证失败 |
根据输入值查找链式运行
检索所有包含所提供文本的链式运行。
等效 API 调用: https://developers.workiva.com/chains-v1/chains-chaininputssearch/
输入
| 输入 | 类型 | 细节 |
| 环境 ID | 文本框 | 您正在查找的环境 ID。 |
| 搜索文本 | 文本框 | 要搜索的输入值。 |
| 最佳效果 | 数字字段 | 要检索的最大结果数。使用 0 检索所有项目。 |
输出
| 输出 | 输出类型 |
| 链式运行 | 文件 |
| 链式运行次数 | 整数 |
退出代码
| 退出代码 | 类型 | 细节 |
| 0 | 成功 | 成功 |
| 1 | 错误 | 普遍失败 |
| 2 | 错误 | 身份验证失败 |
获取链
获取链的属性。
等效 API 调用： https://developers.workiva.com/chains-v1/chains-getchain/
输入
| 输入 | 类型 | 细节 |
| 环境 ID | 文本框 | 目标环境的ID。 |
| 链 ID | 文本框 | 链的ID。 |
输出
| 输出 | 输出类型 |
| 链 | 文件 |
退出代码
| 退出代码 | 类型 | 细节 |
| 0 | 成功 | 成功 |
| 1 | 错误 | 普遍失败 |
| 2 | 错误 | 身份验证失败 |
获取链式命令
获取链中所有命令的属性。
等效 API 调用: https://developers.workiva.com/chains-v1/chains-getcommands/
输入
| 输入 | 类型 | 细节 |
| 环境 ID | 文本框 | 目标环境的ID。 |
| 链 ID | 文本框 | 链的ID。 |
输出
| 输出 | 输出类型 |
| 命令 | 文件 |
退出代码
| 退出代码 | 类型 | 细节 |
| 0 | 成功 | 成功 |
| 1 | 错误 | 普遍失败 |
| 2 | 错误 | 身份验证失败 |
获取链式历史记录
获取链的历史链运行记录。
等效 API 调用: https://developers.workiva.com/chains-v1/chains-chainrunhistory/
输入
| 输入 | 类型 | 细节 |
| 环境 ID | 文本框 | 目标环境的ID。 |
| 链 ID | 文本框 | 链的ID。 |
| 最佳效果 | 数字字段 | 要检索的最大结果数。使用 0 检索所有项目。 |
| 开始日期 | 文本框 | 筛选出指定开始日期之后发生的链式运行。该值可以使用 ISO8601 格式或 Unix 时间戳。 |
| 结束日期 | 文本框 | 筛选在指定结束日期之前发生的链式运行。该值可以使用 ISO8601 格式或 Unix 时间戳。 |
输出
| 输出 | 输出类型 |
| 链式运行 | 文件 |
| 链式运行次数 | 整数 |
退出代码
| 退出代码 | 类型 | 细节 |
| 0 | 成功 | 成功 |
| 1 | 错误 | 普遍失败 |
| 2 | 错误 | 身份验证失败 |
获得连锁运行
获取连锁运行的详细信息。
等效 API 调用: https://developers.workiva.com/chains-v1/chains-getchainrun/
输入
| 输入 | 类型 | 细节 |
| 链式运行 ID | 文本框 | 链式运行的 ID。 |
输出
| 输出 | 输出类型 |
| 连锁跑 | 文件 |
退出代码
| 退出代码 | 类型 | 细节 |
| 0 | 成功 | 成功 |
| 1 | 错误 | 普遍失败 |
| 2 | 错误 | 身份验证失败 |
获取包含节点的链式运行
获取链运行的详细信息，包括节点详细信息。
等效 API 调用: https://developers.workiva.com/chains-v1/chains-getchainrunnodes/
输入
| 输入 | 类型 | 细节 |
| 链式运行 ID | 文本框 | 链式运行的 ID。 |
输出
| 输出 | 输出类型 |
| 连锁跑 | 文件 |
退出代码
| 退出代码 | 类型 | 细节 |
| 0 | 成功 | 成功 |
| 1 | 错误 | 普遍失败 |
| 2 | 错误 | 身份验证失败 |
获取链条
检索特定环境中的所有链及其属性。
等效 API 调用: https://developers.workiva.com/chains-v1/chains-getchains/
输入
| 输入 | 类型 | 细节 |
| 环境 ID | 文本框 | 目标环境的ID。 |
输出
| 输出 | 输出类型 |
| 链结 | 文件 |
| 链的数量 | 整数 |
退出代码
| 退出代码 | 类型 | 细节 |
| 0 | 成功 | 成功 |
| 1 | 错误 | 普遍失败 |
| 2 | 错误 | 身份验证失败 |
获取环境
获取特定环境的属性。
等效 API 调用: https://developers.workiva.com/chains-v1/chains-getenvironment/
输入
| 输入 | 类型 | 细节 |
| 工作区 ID | 文本框 | 环境所在的工作区 ID。 |
| 环境 ID | 文本框 | 目标环境的ID。 |
输出
| 输出 | 输出类型 |
| 环境 | 文件 |
退出代码
| 退出代码 | 类型 | 细节 |
| 0 | 成功 | 成功 |
| 1 | 错误 | 普遍失败 |
| 2 | 错误 | 身份验证失败 |
获取环境
检索工作区中的环境列表。
等效 API 调用: https://developers.workiva.com/chains-v1/chains-getenvironments/
输入
| 输入 | 类型 | 细节 |
| 工作区 ID | 文本框 | 包含环境的工作区的 ID。 |
输出
| 输出 | 输出类型 |
| 环境 | 文件 |
| 环境数量 | 整数 |
退出代码
| 退出代码 | 类型 | 细节 |
| 0 | 成功 | 成功 |
| 1 | 错误 | 普遍失败 |
| 2 | 错误 | 身份验证失败 |
获取工作区
检索工作区及其属性。
等效 API 调用: https://developers.workiva.com/chains-v1/chains-getworkspace/
输入
| 输入 | 类型 | 细节 |
| 工作区 ID | 文本框 | 工作区的ID。 |
输出
| 输出 | 输出类型 |
| 工作区 | 文件 |
退出代码
| 退出代码 | 类型 | 细节 |
| 0 | 成功 | 成功 |
| 1 | 错误 | 普遍失败 |
| 2 | 错误 | 身份验证失败 |
获取工作区
获取公司所有工作区的列表。
等效 API 调用: https://developers.workiva.com/chains-v1/chains-getworkspaces/
输入
没有任何
输出
| 输出 | 输出类型 |
| 工作区 | 文件 |
| 工作区数量 | 整数 |
退出代码
| 退出代码 | 类型 | 细节 |
| 0 | 成功 | 成功 |
| 1 | 错误 | 普遍失败 |
| 2 | 错误 | 身份验证失败 |
发布地图组
发布映射组，由映射组 GUID 指定。
等效 API 调用: https://developers.workiva.com/chains-v1/chains-publish/
输入
| 输入 | 类型 | 细节 |
| 映射组 GUID | 文本框 | 映射组的 GUID。 |
输出
没有任何
退出代码
| 退出代码 | 类型 | 细节 |
| 0 | 成功 | 成功 |
| 1 | 错误 | 普遍失败 |
| 2 | 错误 | 身份验证失败 |
搜索链运行
搜索符合给定筛选条件的链式运行。
等效 API 调用: https://developers.workiva.com/chains-v1/chains-chainfiltersearch/
注： 超级用户或组织管理员不需要设置环境 ID 参数 。
输入
| 输入 | 类型 | 细节 |
| 筛选条件 | 组字段 | 应用于搜索的筛选条件。 |
| 最佳效果 | 数字字段 | 要检索的最大结果数。使用 0 检索所有项目。 |
输出
| 输出 | 输出类型 |
| 链式运行 | 文件 |
| 链式运行次数 | 整数 |
退出代码
| 退出代码 | 类型 | 细节 |
| 0 | 成功 | 成功 |
| 1 | 错误 | 普遍失败 |
| 2 | 错误 | 身份验证失败 |
停止链
停止当前正在运行的链。
等效 API 调用: https://developers.workiva.com/chains-v1/chains-stopchain/
输入
| 输入 | 类型 | 细节 |
| 链式运行 ID | 文本框 | 要停止的链式运行的 ID。 |
输出
| 输出 | 输出类型 |
| 连锁跑 | 文件 |
退出代码
| 退出代码 | 类型 | 细节 |
| 0 | 成功 | 成功 |
| 1 | 错误 | 普遍失败 |
| 2 | 错误 | 身份验证失败 |
上传地图规则
根据映射组 GUID 上传映射组规则集。
等效 API 调用: https://developers.workiva.com/chains-v1/chains-updaterules/
输入
| 输入 | 类型 | 细节 |
| 映射组 GUID | 文本框 | 映射组的 GUID。 |
| 上传模式 | 下拉字段 | 上传模式。当 mode=published时，当前已发布的版本将被更新并重新发布。当 mode=draft时，仅更新草稿。当 mode=both时，已发布版本和草稿都会更新。 |
| 映射规则文件 | 文件字段 | 要上传的包含映射规则的文件。 |
输出
| 输出 | 输出类型 |
| 上传错误 | 文件 |
| 上传结果 | 文件 |
| 已上传规则数量 | 整数 |
| 错误数量 | 整数 |
退出代码
| 退出代码 | 类型 | 细节 |
| 0 | 成功 | 成功 |
| 1 | 错误 | 普遍失败 |
| 2 | 错误 | 身份验证失败 |