Interface for Querying RPA Task Details

Updated on 2023-09-27 GMT+08:00

View PDF

Description

This interface is invoked to query RPA task details.

Interface Method

POST

URL

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

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.
jobName	String	Body	No	Task name. (jobName can be used as a search criterion. If it is specified, uid can be set to null. Either jobName or uid must be passed.)
uid	String	Body	No	Task UUID. (If both jobName and uid are specified, uid is used. Either jobName or uid must be passed.)
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.

Response

**Table 2** Parameters in the response body
Parameter	Type	Position	Mandatory	Description
errorCode	Int	Body	Yes	Error code. The value 0 indicates success and other values indicates failure.
errorMsg	String	Body	No	Error message.
jobDetail	RpaDetailJobResult[]	Body	No	Queue details.

**Table 3** RpaDetailJobResult
Parameter	Type	Position	Mandatory	Description
uid	String	Body	Yes	Task UUID.
jobName	String	Body	Yes	Task name.
startTime	String	Body	No	Job start time. The format is yyyy-mm-dd HH:mm:ss.
createTime	String	Body	Yes	Job creation time. The format is yyyy-mm-dd HH:mm:ss.
workstationName	String	Body	No	Executor name.
clusterName	String	Body	No	Cluster name.
runMode	String	Body	Yes	Running mode. The value can be online.
mode	String	Body	Yes	Execution mode. The options are once, repeat, and queueTrigger.
jobType	String	Body	Yes	Task type, which is fixed at procedure.
status	String	Body	Yes	Task status for search. The options are as follows: init: to be executed running: running suspend: suspended success: completed
procedureName	String	Body	Yes	Script package name.
procedureVersion	String	Body	Yes	Script package version.
description	String	Body	Yes	Task description.
timeout	Integer	Body	No	Task timeout period.
recentTaskStatus	String	Body	No	Latest job status. This field is not returned for tasks that do not generate jobs.
queueUid	String	Body	No	Queue UUID.
queueName	String	Body	No	Queue name.

Example

Request

{
    "tenantId": "202201072597",
    "authToken": "hjbLfhU*******************Fv3nq",
    "uid": "0c9358552188478a8d5ff9203db8791f"
}

Response

{
    "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": "Case creation",
        "createTime": "2022-04-24 17:12:02",
        "procedureName": "AICC_RPA",
        "startTime": "2022-04-29 11:47:25",
        "jobType": "procedure",
        "recentTaskStatus": "failed",
        "status": "running"
    }
}

Parent topic: GTS RPA Integration Interfaces

Previous topic: Interface for Querying the RPA Task List

Next topic: Interface for Creating RPA Queue Data