查询RPA任务列表接口

场景描述

查询RPA任务列表

接口方法

设置成“POST”。

URL

https://IP:PORT/oifde/rest/api/rpa/queryJob

请求说明

表1 请求体参数
参数名称	数据类型	参数位置	必选/可选	描述
tenantId	String	body	True	租户ID 限制长度：64
pageNo	Integer	body	False	查询页数,默认1页
pageSize	Integer	body	False	每页多少条,默认50条可选值：5,10,20,50
conditions	RpaJobCondition	body	False	查询条件
authToken	String	body	True	访问接口的有效Token值。有效Token信息通过获取Token接口获取。请参见C3 智能助手平台接口鉴权方式。限制长度：32

表2 RpaJobConditions参数
参数名称	数据类型	参数位置	必选/可选	描述
jobName	String	body	False	任务名称模糊查询
status	Integer	body	False	任务状态条件搜索,如下： init：待执行 running：运行 suspend：暂停 success：完成

响应说明

表3 响应体参数
参数名称	数据类型	参数位置	必选/可选	描述
errorCode	Int	body	True	错误码返回0：成功其他值：失败
errorMsg	String	body	False	错误信息
total	Int	body	False	总记录数
jobs	RpaDetailJobResult[]	body	False	任务列表,成功时必须返回。

表4 RpaDetailJobResult 参数说明
参数名称	数据类型	参数位置	必选/可选	描述
uid	String	body	False	任务UUID
jobName	String	body	False	任务名称
createTime	String	body	False	任务创建时间
startTime	String	body	False	任务开始时间
status	String	body	False	任务状态,枚举类型为： init：待执行 running：运行 success：完成 suspend：暂停
mode	string	body	False	执行方式：once、repeat
runMode	string	body	False	运行模式：在线online；离线offline
timeout	Integer	body	False	任务的超时时间,单位s
description	string	body	False	任务描述

报文样例

请求消息样例

{
    "tenantId": "202201072597",
    "authToken": "hjbLf*******************RQFv3nq",
    "pageNo": 1,
    "pageSize": 10,
    "conditions": {}
}

响应消息样例

{
    "total": 1,
    "jobs": [
        {
            "uid": "0c9358552188478a8d5ff9203db8791f",
            "jobName": "AICC_RPA",
            "createTime": "2022-04-24 17:12:02",
            "startTime": "2022-04-29 11:47:25",
            "status": "running",
            "mode": "queueTrigger",
            "runMode": "online",
            "timeout": 120,
            "description": null
        }
    ],
    "errorCode": 0,
    "errorMsg": null
}

父主题： GTS RPA集成接口

上一篇：GTS RPA集成接口

下一篇：查询RPA任务详情接口