Control Room API
- Updated: 2025/05/13
Control Room API
Automation Anywhere Control Room 提供了 API,使您能够自定义您(和您的自动化)与 Automation Anywhere 互动的方式。
重要:
- 从版本 Automation 360 v.34 开始,以下 WLM API 端点被弃用,并计划在 v.38 版本发布时停止使用 (EoL):
-
POST
/v3/wlm/workitemmodel
-
GET
/v3/wlm/workitemmodels/{id}
-
GET
/v3/wlm/queues/{id}
-
POST
/v3/wlm/queues/{id}/consumers
-
POST
/v3/wlm/queues/{id}/participants
-
PUT
/v3/wlm/queues/{id}/members/{userId}
-
POST
/v3/wlm/queues/{id}/file
-
PUT
/v3/wlm/queues/{id}/workitems/{workItemId}
-
POST
/v4/wlm/workitemmodel
-
GET
/v4/wlm/workitemmodels/{id}
-
GET
/v4/wlm/queues/{id}
-
POST
/v4/wlm/queues/{id}/consumers
-
POST
/v4/wlm/queues/{id}/participants
-
PUT
/v4/wlm/queues/{id}/members/{userId}
-
POST
/v4/wlm/queues/{id}/file
-
PUT
/v4/wlm/queues/{id}/workitems/{workItemId}
-
POST
- 从 Automation 360 v.34 开始,Bot Scheduler API 端点:
/v1/schedule/automations
已被弃用,并被替换为/v2/schedule/automations
。 v1 版本计划在 v.38 版本发布时停止使用 (EoL)
您可以在以下 API 参考部分查看并导航到所有 Control Room API 模块及其相关端点。
不同的 API 版本代表 API 随时间演进的不同迭代。 随着 API 的发展,会引入新功能或改进。 为了管理这些更改并保持与现有应用程序的兼容性,开发人员使用版本控制。
v1 端点
模块 | 描述 |
---|---|
身份验证 API | 使用 v1 身份验证 API 验证 JSON Web 令牌 (JWTs) 的真实性和完整性,并终止活跃用户会话。 |
审核 API | 使用审核 API 从您的 Control Room 检索审核日志数据。 |
设备 API | 使用设备 API 识别所有具有无人值守 Bot Runner 许可证的可用用户,或按名称筛选用户。 |
自动化 API | 已弃用 使用 v1 Bot Scheduler API(自动化 API)创建、更新、删除和返回计划自动化的详细信息。 |
触发器 API | 使用触发器 API 将触发器映射到用户或有人值守 Bot Runner 用户的角色。 您还可以创建和删除事件触发器。 |
API Task Execution API | 使用 API 任务执行 API 生成一个 API 任务执行 URL 和一个令牌,以通过 API 端点启动 API 任务执行。 |
策略管理 API | 使用策略管理 API 管理 Control Room 中的代码分析、策略和规则。 |
AI Agent Studio API | 使用 AI Agent Studio API 定义和连接自定义 Model connections 模型。 您还可以检索和删除自定义 Model connections。 |
v2 端点
模块 | 描述 |
---|---|
身份验证 API | 使用 v2 身份验证 API 生成和刷新在所有企业 Control Room API 中授权所需的 JSON Web 令牌 (JWT)。 |
用户管理 API | 使用用户管理 API 查看和删除 Control Room 中的角色和用户。 |
凭据保管库 API | 使用凭据保管库 API 创建、检索、更新和删除凭据、凭据属性值、存储柜和密钥。 |
机器人执行编排器 API | 使用 v2 机器人执行编排器 API 监控设备。 |
存储库管理 API | 使用存储库管理 API 对 Control Room 中您有权限访问的对象(机器人、文件夹和文件)执行特定任务。 |
机器人洞察 API | 使用机器人洞察 API 访问实时业务洞察和数字劳动力性能数据,以利用已部署自动化的内容级生产力数据。 |
BLM API | 使用机器人生命周期管理 (BLM) API 导出和导入机器人及其依赖文件和命令包,以实现全面的自动化生命周期管理。 |
设备池 API | 使用设备池 API 创建、列出、更新和删除设备池。 |
许可证 API | 使用许可证 API 检索 Control Room 许可证详细信息,并在许可证重新分配或续订后手动同步 Control Room 与许可证服务器。 |
Process Composer API | 使用 Processor Composer API 从流程创建新请求,并按参考 ID 检索初始表单和请求。 |
自动化 API | 使用 v2 Bot Scheduler API(自动化 API)创建、更新、删除和返回计划自动化的详细信息。 |
策略管理 API | 使用 v2 策略管理 API 管理 Control Room 内的代码分析、策略和规则。 |
v3 端点
模块 | 描述 |
---|---|
机器人部署 API | 使用 v3 机器人部署 API 将机器人从公共工作区部署到 Bot Runner 设备。 |
工作负载管理 API | 使用 v3 工作负载管理 (WLM) API 以编程方式管理和创建 Control Room 中的工作项模型、队列、工作项和自动化。 |
迁移 API(机器人迁移) | 使用 v3 迁移 API 将企业客户端版本 Enterprise 11 和 Enterprise 10 中创建的 TaskBot 和 MetaBot 迁移到 Automation 360。 |
机器人执行编排器 API | 使用 v3 机器人执行编排器 API 监控自动化活动进度。 |
v4 端点
模块 | 描述 |
---|---|
机器人部署 API (V4) | 使用 v4 机器人部署 API 将机器人从公共工作区部署到 Bot Runner 设备。 |
工作负载管理 API | 使用 v4 工作负载管理 (WLM) API 以编程方式管理和创建 Control Room 中的工作项模型、队列、工作项和自动化。 |
迁移 API(机器人迁移) | 使用 v4 迁移 API 将企业客户端版本 Enterprise 11 和 Enterprise 10 中创建的 TaskBot 和 MetaBot 迁移到 Automation 360。 |
注: 为避免出错并确保顺利处理您的请求,请记住,所有 JSON 参数名称均区分大小写。 有关更多信息,请参阅 API 参考文档的相关部分,查阅详细指南和示例,帮助您使用正确的大小写构建查询和请求体。
Control Room API 入门
所有请求必须包含带有 JSON 身份验证令牌的 X-Authorization 标头,或带有 Bearer 令牌的 Authorization 标头,用于向 Control Room 提出请求。 以下部分提供有关 Control Room API 可用端点、方法、资源、身份验证方案、参数和标头的详细信息,以及常见请求和响应的示例。
注:
Automation 360 v.27 版本及更高版本支持 Bearer 令牌。 之前的所有版本都不支持且忽略该令牌。 您必须从我们的 OAuth 服务中获取 Bearer 令牌。 要授权您的访问,请使用 X-Authorization(使用身份验证 API)或 Authorization(使用 OAuth)。 您不能在同一个 API 中同时使用这两者。
您可以使用 Control Room Swagger 文档查看和运行 API。 通过使用链接 https://{control-room}/swagger/ 访问 Control Room Swagger 文档,并将 {control-room} 替换为您的 Control Room 实例。 以下部分提供了有关如何编写Control Room API 请求的有用信息:
- 部分 API 需要您对结果进行筛选、分页和排序,以获得所需的输出。 有关筛选、分页和排序的更多信息,请参阅 筛选、分页和排序。
- 响应中的 API 响应代码在 API 响应代码 中进行了描述。
- 比较 Automation 360 和 Enterprise 11 API 比较了 Enterprise 11 和 Automation 360 API。
API 弃用策略
API 弃用 表示不再推荐使用该 API,但它仍然是可用的。 鼓励开发人员迁移到更新的、受支持的 API 版本。 该 API 将可用至生命周期结束 (EoL) 日期和发布版本,以确保平稳过渡。
API 生命周期结束 (EoL) 表示 API 停止运行并不再可用的日期和发行版本。 开发人员应在此日期之前完成向较新、受支持的 API 版本的迁移。
以下情形可能需要弃用 API:
- 安全漏洞: 旧版本的 API 包含已在新版本中修复的已知安全漏洞。
- 技术债务: 旧的 API 版本可能基于不再受支持的过时技术、方法或框架,因此很难进行维护或增强。
- 性能: 较旧的 API 版本没有针对现代场景或规模的扩大进行优化,导致性能低下和响应时间变慢。
- 用户体验: 已弃用的 API 版本包含令人困惑或冗余的端点,可能会使用户难以导航。
API 的支持期至少为 2 年。 2 年后,可能会宣布某个 API 弃用,该 API 将至少再提供一年(四个版本),以便为您提供足够的时间迁移到更新的版本。
注: 上述策略不适用于因公共 API 的安全漏洞而导致的弃用。 在这种情况下,需要立即采取行动以降低风险,我们将尽一切努力尽快将这一变更通知您。