queryTaskByClientIdAndStatus

Updated at:

Request URL: console-rpa.aliyun.com/rpa/openapi/client/queryTaskByClientIdAndStatus

Request method: GET

Response format: JSON

Description: Queries the number of tasks for a specified client.

Request parameters

Name

Type

Required

Example

Description

clientIds

String

Yes

5E77DA4EB87B******8B9527626A47F4

The unique identifier of the client. To query tasks for multiple clients, separate the client identifiers with a comma (,). Example: 5E77DA4EB87BCFB62A8B9527626A47F4,50E6071F3ABCB36B6DECCE2BB4C2A303

status

String

No

running

Task state table

Response parameters

For more information about common response parameters, see Response parameters. The following table describes the fields in the data parameter.

Name

Type

Example

Description

uuid

String

5e91dcd6-****-****-****-9b839422009e

The unique identifier of the task.

taskBatchId

String

null

The task batch.

appId

String

fb6a99a1-****-****-****-2ed9cb5a0c0d

The unique identifier of the application.

appName

String

TestAPP1

The name of the flow application.

clientId

String

5E77DA4EB8******2A8B9527626A47F4

The unique identifier of the client.

status

String

error

The task status. For more information, see Task state table.

result

String

The client is disconnected. The task is terminated.

The task result.

beginTime

Date

2020-04-22 14:04:31

The start time.

endTime

Date

2020-04-22 14:11:28

The end time.

triggerType

String

manual

The trigger type.

taskTrigger

String

null

The trigger.

Examples

Request example:

https://console-rpa.aliyun.com/rpa/openapi/client/queryClientViews?<Common request parameters>
&clientIds=5E77DA4EB87B******8B9527626A47F4
&status=running

Response example:

{
    "requestId":"7906bcd8-5054-4be4-a08f-27e13630607e",
    "success":true,
    "code":0,
    "msg":"The call is successful.",
    "msgCode":"result.success",
    "data":[
        {
            "uuid":"5e91dcd6-****-****-****-9b839422009e",
            "taskBatchId":null,
            "appId":"fb6a99a1-****-****-****-2ed9cb5a0c0d",
            "appName":"TestAPP1",
            "clientId":"5E77DA4EB8******2A8B9527626A47F4",
            "status":"error",
            "result":"The client is disconnected. The task is terminated.",
            "beginTime":"2020-04-22 14:04:31",
            "endTime":"2020-04-22 14:11:28",
            "triggerType":"manual",
            "taskTrigger":null
        }
    ],
    "pager":null
}