OpenAPI概览
CubeRPA平台是新一代RPA数字机器人平台，面向企业办公场景设计，通过界面图形化拖拽操作即可完成自动化流程编排，助力企业数字化转型。您可以通过本文档提供API接口，在任何时间、任何地点、任何互联网设备上进行机器人和任务的相关操作。
# 使用说明
CubeRPA企业旗舰版支持通过调用API实现对机器人、任务运行及资产的管理。API概览主要介绍接口的请求语法、相关参数含义以及请求和返回示例。接口的具体使用请参考接口文档。
# OpenAPI概览
# 关于运行准备的OpenAPI
| 接口名称 | 描述 |
|---|---|
| 获取应用列表 (opens new window) | 调用获取应用列表（GetAppList）接口获取企业市场及公开市场所有可获取应用。 |
| 获取应用并生成机器人 (opens new window) | 调用获取应用并生成机器人（createRobot）接口将指定应用获取至当前外部应用程序中，并生成机器人。 |
| 获取机器人列表 (opens new window) | 调用获取机器人列表（GetRobotList）接口获取当前外部应用程序可调配的机器人列表。已删除的机器人不支持获取。 |
| 获取Talent列表 (opens new window) | 调用获取Talent列表（GetTalentList）接口获取已授权给当前外部应用程序的Talent列表。 |
# 关于任务运行的OpenAPI
| 接口名称 | 描述 |
|---|---|
| 创建集群任务 (opens new window) | 调用创建集群任务（CreateClusterTask）接口手动触发指定机器人的集群运行任务，需指定任一Talent。 |
| 终止任务 (opens new window) | 调用终止任务（TerminateTask）接口根据任务唯一标识终止指定任务。 |
| 查询任务状态 (opens new window) | 调用查询任务状态（QueryTaskStatus）接口根据任务唯一标识查询指定任务的执行状态。 |
| 查询任务结果 (opens new window) | 调用查询任务结果（QueryTaskResults）接口根据任务唯一标识查询指定任务的执行结果。 |
| 下载任务运行日志 (opens new window) | 调用下载任务运行日志（DownloadTaskLogs）接口根据任务唯一标识获取指定任务运行日志文件的下载链接。 |
# 关于资产的OpenAPI
| 接口名称 | 描述 |
|---|---|
| 获取数据队列列表 (opens new window) | 调用获取数据队列列表（GetDataQueueList）接口获取供当前用户使用的数据队列列表。 |
| 向数据队列写入数据 (opens new window) | 调用向数据队列写入数据（AddDatatoDataQueue）接口根据数据队列唯一标识向指定数据队列中写入数据。 |
| 查询消息处理结果 (opens new window) | 调用查询消息处理结果（QueryMessageResults）接口根据数据队列唯一标识查询指定消息的处理结果。 |
| 查询数据队列未消费消息数 (opens new window) | 调用查询数据队列未消费消息数（QueryUnconsumed messagesinDataQueue）接口根据数据队列唯一标识查询指定数据队列中未消费的消息条数。 |
最近更新时间: {
"value": "2023-08-09",
"effect": true
}