查询RPA队列数据接口
场景描述
查询RPA队列数据
接口方法
设置成“POST”。
URL
https://IP:PORT/oifde/rest/api/rpa/queryRpaQueueData
请求说明
参数名称 |
数据类型 |
参数位置 |
必选/可选 |
描述 |
|---|---|---|---|---|
tenantId |
String |
body |
True |
租户ID 限制长度：64 |
authToken |
String |
body |
True |
访问接口的有效Token值。 有效Token信息通过获取Token接口获取。 请参见C3 智能助手平台接口鉴权方式。 限制长度：32 |
pageNo |
Integer |
body |
False |
查询页数，默认1页 |
pageSize |
Integer |
body |
False |
每页多少条，默认50条 可选值：5，10，20，50 |
conditions |
RpaQueueDataConditions |
body |
True |
查询条件。 队列数据uid或者队列queueUid必须传入一个值。 |
参数名称 |
数据类型 |
参数位置 |
必选/可选 |
描述 |
|---|---|---|---|---|
uid |
string |
body |
False |
根据队列数据UUID查询（至少传递uid、queueUid、queueName中一个参数） |
queueUid |
string |
body |
False |
根据队列数据UUID查询（至少传递uid、queueUid、queueName中一个参数） |
queueName |
string(32) |
body |
False |
根据队列名称查询（至少传递uid、queueUid、queueName中一个参数） |
tag |
string |
body |
False |
根据队列数据标签查询 |
status |
string |
body |
False |
根据队列状态查询，枚举类型为
|
inactived |
string |
body |
False |
根据队列启用状态查询，枚举类型为：
|
priority |
string |
body |
False |
根据队列优先级查询，枚举类型为：
|
响应说明
参数名称 |
数据类型 |
参数位置 |
必选/可选 |
描述 |
|---|---|---|---|---|
errorCode |
int |
body |
True |
错误码 返回0：成功 其他值：失败 |
errorMsg |
String |
body |
False |
错误信息 |
total |
int |
body |
False |
队列数据条数，成功时必须返回。 |
queueData |
QueueData[] |
body |
False |
队列数据，成功时必须返回。 |
参数名称 |
数据类型 |
参数位置 |
必选/可选 |
描述 |
|---|---|---|---|---|
id |
long |
body |
False |
队列数据自增ID |
uid |
string |
body |
False |
队列数据UUID |
queueName |
string(32) |
body |
False |
队列名称 |
queueUid |
string |
body |
False |
队列UUID |
createTime |
long |
body |
False |
创建时间(0-7258089600000L)时间戳 |
expectStartTime |
long |
body |
False |
计划开始时间(0-7258089600000L)时间戳 |
expectEndTime |
long |
body |
False |
计划结束时间(0-7258089600000L)时间戳 |
status |
string |
body |
False |
队列状态枚举类型为：
|
priority |
string |
body |
False |
优先级枚举类型为：
|
inactived |
string |
body |
False |
队列启用状态枚举类型为：
|
tag |
string(32) |
body |
False |
队列数据标签 |
inputJsonData |
string(65535) |
body |
False |
输入的队列数据，json格式字符串 |
outputJsonData |
string(65535) |
body |
False |
输出的结果数据，json格式字符串 |
analysisJsonData |
string(65535) |
body |
False |
中间的队列数据，json格式字符串 |
failedReason |
string(512) |
body |
False |
失败原因 |
failedReasonDetail |
string(65535) |
body |
False |
失败原因细节 |
description |
string(100) |
body |
False |
队列数据描述 |
progress |
int |
body |
False |
进度(0-100) |
报文样例
- 请求消息样例
{ "tenantId": "202201072597"， "authToken": "oqyo*******************fGMCu"， "pageNo": 1， "pageSize": 10， "conditions": { "uid": "000145cdb75b3a514821872b9734f02ae76d"， "queueUid": "00019cad3dd5c71d4696b209d7024fa04d3a" } } - 响应消息样例
{ "errorCode": 0， "errorMsg": null， "total": 1， "queueData": [ { "id": 44， "uid": "000145cdb75b3a514821872b9734f02ae76d"， "queueName": "创建工单"， "queueUid": "00019cad3dd5c71d4696b209d7024fa04d3a"， "createTime": 1651027548328， "expectStartTime": null， "expectEndTime": null， "status": "success"， "priority": "normal"， "inactived": "active"， "tag": null， "inputJsonData": "{\"caseId\":\"0607000000t1FY2F0Mb2\"}"， "outputJsonData": null， "analysisJsonData": null， "failedReason": null， "failedReasonDetail": null， "description": "描述队列数据"， "progress": null } ] }
