查询RPA任务详情接口
场景描述
查询RPA任务详情
接口方法
设置成“POST”。
URL
https://IP:PORT/oifde/rest/api/rpa/queryJobDetails
请求说明
参数名称 |
数据类型 |
参数位置 |
必选/可选 |
描述 |
---|---|---|---|---|
tenantId |
String |
body |
True |
租户ID 限制长度:64 |
jobName |
String |
body |
False |
任务名称(根据jobName来查询,uid可设置为null,jobName或者uid必须传入一个值。) |
uid |
String |
body |
False |
任务UUID(jobName和uid都填,以uid为准,jobName或者uid必须传入一个值。) |
authToken |
String |
body |
True |
访问接口的有效Token值。 有效Token信息通过获取Token接口获取。 请参见C3 智能助手平台接口鉴权方式。 限制长度:32 |
响应说明
参数名称 |
数据类型 |
参数位置 |
必选/可选 |
描述 |
---|---|---|---|---|
errorCode |
Int |
body |
True |
错误码 返回0:成功 其他值:失败 |
errorMsg |
String |
body |
False |
错误信息 |
jobDetail |
RpaDetailJobResult[] |
body |
False |
队列详情 |
参数名称 |
数据类型 |
参数位置 |
必选/可选 |
描述 |
---|---|---|---|---|
uid |
string |
body |
True |
任务UUID |
jobName |
string |
body |
True |
任务的名称 |
startTime |
string |
body |
False |
作业开始时间, 格式:yyyy-mm-dd HH:mm:ss |
createTime |
string |
body |
True |
作业创建时间, 格式:yyyy-mm-dd HH:mm:ss |
workstationName |
string |
body |
False |
执行器名称 |
clusterName |
string |
body |
False |
集群名称 |
runMode |
string |
body |
True |
运行模式:在线online |
mode |
string |
body |
True |
执行方式:once、repeat、queueTrigger |
jobType |
string |
body |
True |
任务类型固定为procedure |
status |
string |
body |
True |
任务状态条件搜索,如下:
|
procedureName |
string |
body |
True |
脚本包名称 |
procedureVersion |
string |
body |
True |
脚本包版本 |
description |
string |
body |
True |
任务描述 |
timeout |
int |
body |
False |
任务超时时间 |
recentTaskStatus |
string |
body |
False |
最近一次作业状态,没有生成作业的任务不会返回该字段 |
queueUid |
string |
body |
False |
队列的UUID |
queueName |
string |
body |
False |
队列名称 |
报文样例
- 请求消息样例
{ "tenantId": "202201072597", "authToken": "hjbLfhU*******************Fv3nq", "uid": "0c9358552188478a8d5ff9203db8791f" }
- 响应消息样例
{ "errorCode": 0, "errorMsg": null, "jobDetail": { "jobName": "AICC_RPA", "queueUid": "00019cad3dd5c71d4696b209d7024fa04d3a", "workstationName": "AICC_RPA", "runMode": "online", "timeout": 120, "mode": "queueTrigger", "uid": "0c9358552188478a8d5ff9203db8791f", "procedureVersion": "1.0.5", "queueName": "创建工单", "createTime": "2022-04-24 17:12:02", "procedureName": "AICC_RPA", "startTime": "2022-04-29 11:47:25", "jobType": "procedure", "recentTaskStatus": "failed", "status": "running" } }