Interface for Querying RPA Queue Data
Description
This interface is invoked to query RPA queue data.
Interface Method
POST
URL
https://IP:PORT/oifde/rest/api/rpa/queryRpaQueueData
Request
Parameter |
Type |
Position |
Mandatory |
Description |
---|---|---|---|---|
tenantId |
String |
Body |
Yes |
Tenant ID. The value can contain a maximum of 64 characters. |
authToken |
String |
Body |
Yes |
Valid token value for accessing the interface. You can obtain the valid token information by invoking the interface for obtaining tokens. For details, see C3 OIAP Interface Authentication. The value can contain a maximum of 32 characters. |
pageNo |
Integer |
Body |
No |
Number of pages to be queried. The default value is 1. |
pageSize |
Integer |
Body |
No |
Number of data records on each page. The default value is 50. The value can be 5, 10, 20, or 50. |
conditions |
RpaQueueDataConditions |
Body |
Yes |
Search criteria. Either uid or queueUid must be passed. |
Parameter |
Type |
Position |
Mandatory |
Description |
---|---|---|---|---|
uid |
String |
Body |
No |
Queue data UUID for query (at least one of the uid, queueUid, and queueName parameters must be transferred). |
queueUid |
String |
Body |
No |
Queue data UUID for query (at least one of the uid, queueUid, and queueName parameters must be transferred). |
queueName |
String (32) |
Body |
No |
Queue name for query (at least one of uid, queueUid, and queueName must be transferred). |
tag |
String |
Body |
No |
Queue data label for query. |
status |
String |
Body |
No |
Queue status for query. The options are as follows:
|
inactived |
String |
Body |
No |
Queue enabling status for query. The options are as follows:
|
priority |
String |
Body |
No |
Queue priority for query. The options are as follows:
|
Response
Parameter |
Type |
Position |
Mandatory |
Description |
---|---|---|---|---|
errorCode |
Integer |
Body |
Yes |
Error code. The value 0 indicates success and other values indicates failure. |
errorMsg |
String |
Body |
No |
Error message. |
total |
Integer |
Body |
No |
Number of queue data records, which must be returned when the operation is successful. |
queueData |
QueueData[] |
Body |
No |
Queue data, which must be returned when the operation is successful. |
Parameter |
Type |
Position |
Mandatory |
Description |
---|---|---|---|---|
id |
Long |
Body |
No |
Queue data ID that is automatically assigned. |
uid |
String |
Body |
No |
Queue data UUID. |
queueName |
String (32) |
Body |
No |
Queue name. |
queueUid |
String |
Body |
No |
Queue UUID. |
createTime |
Long |
Body |
No |
Creation timestamp. The value ranges from 0 to 7258089600000L. |
expectStartTime |
Long |
Body |
No |
Planned start timestamp. The value ranges from 0 to 7258089600000L. |
expectEndTime |
Long |
Body |
No |
Planned end timestamp. The value ranges from 0 to 7258089600000L. |
status |
String |
Body |
No |
Queue status. The options are as follows:
|
priority |
String |
Body |
No |
Priority. The options are as follows:
|
inactived |
String |
Body |
No |
Queue enabling status. The options are as follows:
|
tag |
String (32) |
Body |
No |
Queue data label. |
inputJsonData |
String (65535) |
Body |
No |
Input queue data, which is a JSON character string. |
outputJsonData |
String (65535) |
Body |
No |
Output result data, which is a JSON character string. |
analysisJsonData |
String (65535) |
Body |
No |
Intermediate queue data, which is a JSON character string. |
failedReason |
String (512) |
Body |
No |
Failure cause. |
failedReasonDetail |
String (65535) |
Body |
No |
Failure cause details. |
description |
String (100) |
Body |
No |
Queue data description. |
progress |
Integer |
Body |
No |
Progress. The value ranges from 0 to 100. |
Example
- Request
{ "tenantId": "202201072597", "authToken": "oqyo*******************fGMCu", "pageNo": 1, "pageSize": 10, "conditions": { "uid": "000145cdb75b3a514821872b9734f02ae76d", "queueUid": "00019cad3dd5c71d4696b209d7024fa04d3a" } }
- Response
{ "errorCode": 0, "errorMsg": null, "total": 1, "queueData": [ { "id": 44, "uid": "000145cdb75b3a514821872b9734f02ae76d", "queueName": "Case creation", "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": "Queue data description", "progress": null } ] }
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot