Help Center/ Cognitive Engagement Center/ API Reference/ Chatbot Management Interface Reference/ GTS RPA Integration Interfaces/ Interface for Creating RPA Queue Data
Updated on 2023-09-27 GMT+08:00
View PDF
Share

Interface for Creating RPA Queue Data

Description

This interface is invoked to create RPA queue data.

Interface Method

The request method must be set to POST.

URL

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

Request

Table 1 Parameters in the request body

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.

tag

String (32)

Body

No

Queue data label, which is unique for the same queue.

priority

String

Body

No

Priority. The default value is normal. The options are as follows:

  • low: low
  • normal: medium
  • high: high

inputJsonData

String (65535)

Body

No

Input queue data, which is a JSON character string.

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.

description

String (100)

Body

No

Queue data description.

queueUid

String

Body

Yes

Queue UUID, which is unique.

Response

Table 2 Parameters in the response body

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.

queueData

QueueData[]

Body

No

Queue data, which must be returned when the operation is successful.
Table 3 QueueData

Parameter

Type

Position

Mandatory

Description

id

Long

Body

No

Queue data ID that is automatically added.

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:

  • init: waiting for processing
  • processing: processing
  • success: success
  • failed: failed

priority

String

Body

No

Priority. The options are as follows:

  • low: low
  • normal: medium
  • high: high

inactived

String

Body

No

Queue enabling status. The options are as follows:

  • active: enabled
  • inactive: disabled

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 Example 
    {
    "tenantId": "202201010101",
    "authToken": "abcdefg",
    "inputJsonData": {
        "caseId": "0000000002",
        "userId": "123456",
    },
    "description": "Queue data description",
    "queueUid": "123456789",
    "priority": "normal"
}
  • Response Example 
    {
    "errorCode": 0,
    "errorMsg": null,
    "queueData": {
        "id": 67,
        "uid": "1234567890123",
        "queueName": "Case creation",
        "queueUid": "123456789",
        "createTime": 1652100233488,
        "expectStartTime": null,
        "expectEndTime": null,
        "status": "init",
        "priority": "normal",
        "inactived": "active",
        "tag": null,
        "inputJsonData": "{\"caseId\":\"0000000002\"}",
        "outputJsonData": null,
        "analysisJsonData": null,
        "failedReason": null,
        "failedReasonDetail": null,
        "description": "Queue data description",
        "progress": null
    }
}