ListTaskDetails

Updated at:

Description: Queries the details of one or more specified tasks.

Path:/rpa/openapi/raas/task/ListTaskDetails

Method:GET

Usage:

  • No special instructions.

Limitations:

Important

For information about API usage limits, see Usage Limits.

request parameters:

Parameter

Type

Required

Example

Description

TaskIds

Array of String. Serialization method: simple.

Yes

["3226a05a -****-****-****- b8fb7e4561c6", "092fb04a -****-****-****- 6c0301a3b066"]

The IDs of the tasks to query. You can specify up to 10 task IDs in a single call. If you need to query more tasks, submit the requests in batches.

response parameters:

For information about common response parameters, see Return results. The following table describes the parameters in the data array.

Parameter

Type

Example

Description

TaskId

String

ca9be99c -****-****-****- ee6a1f67cb68

The task ID.

TaskStatus

String

complete

The task status.

TaskStatusLatestUpdateTime

String

2022-05-16 21:07:03

The time when the task status was last updated.

TaskBeginTime

String

2022-05-16 20:00:00

The time when the task started.

TaskEndTime

String

2022-05-16 21:07:03

The time when the task ended.

AllocateMode

String

manu

The allocation mode.

TaskPriority

Integer

50

The task priority.

AppId

String

de6f8980 -****-****-****- 3b0090c2d12f

The application ID.

AppParams

Array of Json

[{"name":"param1","value":""},{"name":"param2","value":""}]

The application input parameters specified when the task was created.

TaskResult

String

Example result

For usage and limits, see task_result.

RobotId

String

11DC8 ****** 1A4E463B1E538436035653

The robot ID.

PackId

String

bv2XPrDl

The robot group ID.

CallbackUrl

String

http://example.callback.com

The callback URL specified when the task was created.

TaskErrorInfo

Object. Serialized in JSON format.

{

"Source": "client",

"Description": "Timed out while waiting for a UI control.",

"Operator": {

"Id": "exampleUserId",

"Name": "exampleUserName"

},

"StatusCode": {

"Code": "0000",

"Value": "terminatedUnexpected"

}

}

Details about a task failure. This parameter is null if the task completes successfully. For more information about the fields in this object, see the table below.

HciTodo

Object. Serialized in JSON format.

{

"HciTodoId": "069c21c7-******",

"TaskId": "7d5aac96-******",

"TodoDetail": "The automated operation is waiting for the user to complete the guided operation before it can continue.",

"TimeoutMin": 120,

"Status": "open",

"CreateTime": "2026-08-26 15:59:36",

"ModifiedTime": "2026-08-26 15:59:36"

}

  • If the automated process sends an HCI notification, this parameter contains the content of the latest notification.

  • This parameter is null if no HCI notification is sent.

  • For more information about HCI, see HCI.

NeedHumanIntervention

String

True

  • Indicates whether the task requires human intervention. Valid values are True and False.

  • For more information about HCI, see HCI.

The following table describes the fields in the TaskErrorInfo object.

Parameter

Type

Example

Description

Source

String

api

The source that caused the task to terminate abnormally. Valid values: console, api, and client.

Description

String

The task was terminated manually.

A brief description of the abnormal termination.

Operator

Object. Serialized in JSON format.

{

"Id": "exampleUserId",

"Name": "exampleUserName"

}

Information about the operator. The Id field is the user ID and the Name field is the user name. Both fields are strings.

StatusCode

Object. Serialized in JSON format.

{

"Code": "4000",

"Value": "raas.task.terminatedManually"

}

The task status code. Both fields are strings. Valid values:

0000: Default value, which indicates an abnormal termination.

3001: The task was stopped from the console.

3002: The robot group to which the task belongs was deleted from the console.

3004: The robot to which the task belongs was deleted from the console.

4001: The task was stopped by an API call.

4002: The robot group to which the task belongs was deleted by an API call.

4004: The robot to which the task belongs was deleted by an API call.

4005: The task was terminated because the queue was cleared by an API call.

The following table describes the fields in the HciTodo object.

Parameter

Type

Example

Description

HciTodoId

String

069c21c7-******

The HCI notification ID.

TaskId

String

7d5aac96-******

The task ID.

TodoDetail

String

The automated operation is waiting for the user to complete the guided operation before it can continue.

The text of the prompt that requests human intervention.

TimeoutMin

Integer

120

The timeout period for the HCI wait, in minutes.

Status

String

open

The current status of the HCI notification.

CreateTime

String

2026-08-26 15:59:36

The creation time of the HCI notification.

ModifiedTime

String

2026-08-26 15:59:36

The last modified time of the HCI notification.

Request example:

https://console-rpa.aliyun.com/rpa/openapi/raas/task/ListTaskDetails?
&TaskIds=%5B014b9ab1-51c2-446f-b8c1-b685429a8764%5D
&<common request parameters>

Response example:

{
	"requestId": "0c9be650-****-****-****-7f29841d8207",
	"success": true,
	"code": 0,
	"msg": "The request was successful.",
	"msgCode": "result.success",
	"data": [{
		"TaskId": "db23a4a0-****-****-****-667453882246",
		"TaskStatus": "complete",
		"TaskStatusLatestUpdateTime": "2022-07-21 16:36:46",
		"TaskBeginTime": "2022-07-21 16:36:37",
		"TaskEndTime": "2022-07-21 16:36:46",
		"AllocateMode": "auto",
		"TaskPriority": 50,
		"AppId": "0925860d-****-****-****-446d0cdb2ff5",
		"AppParams": null,
		"TaskResult": null,
		"RobotId": "6579633******178CAC2FCBD5BD0B4EC",
		"PackId": "nO5494bS",
		"CallbackUrl": "http://example.callback.com",
    "TaskErrorInfo":"{
                      	\"Source\": \"client\",
                      	\"Description\": \"Timed out while waiting for a UI control.\",
                      	\"Operator\": {
                      		\"Id\": \"exampleUserId\",
                      		\"Name\": \"exampleUserName\"
                      	},
                      	\"StatusCode\": {
                      		\"Code\": \"0000\",
                      		\"Value\": \"terminatedUnexpected\"
                      	}
                      }",
                 "HciTodo": null,
		 "NeedHumanIntervention": false
	}],
	"pager": null,
	"instanceId": null
}