API overview
API overview
Alibaba Cloud Robotic Process Automation (RPA) provides the following server-side APIs.
Bot client
Name | Method | Path | Description |
queryClientViews | get | /rpa/openapi/client/queryClientViews | Queries client information. |
queryTaskByClientIdAndStatus | get | /rpa/openapi/client/queryTaskByClientIdAndStatus | Queries the number of tasks for a specific client. |
updateClientStatus | post | /rpa/openapi/client/updateClientStatus | Changes the client status. |
updateClientDispatchMode | post | /rpa/openapi/client/updateClientDispatchMode | Changes the scheduling status of a client. |
updateClientInfo | post | /rpa/openapi/client/updateClientInfo | Updates client information. |
disconnectClient | post | /rpa/openapi/client/disconnectClient | Disconnects a client connection. |
deleteClient | post | /rpa/openapi/client/deleteClient | Deletes a client. |
queryClientByUuid | get | /rpa/openapi/client/queryClientByUuid | Queries client information by its unique identifier. |
queryClientViewById | get | /rpa/openapi/client/queryClientViewById | Queries client information. |
queryMemberClientViews | get | /rpa/openapi/client/queryMemberClientViews | Queries the list of clients a user is logged on to. |
Applications
Name | Method | Path | Description |
queryApps | get | /rpa/openapi/app/queryApps | Retrieves a list of applications. |
applyApp | post | /rpa/openapi/app/applyApp | Requests an application. |
queryApplyList | get | /rpa/openapi/app/queryApplyList | Retrieves a list of requests. |
queryMyAppApplys | get | /rpa/openapi/app/queryMyAppApplys | Queries your list of requests. |
queryMyApps | get | /rpa/openapi/app/queryMyApps | My app list |
approve | post | /rpa/openapi/app/approve | On request |
reject | post | /rpa/openapi/app/reject | Rejects a request. |
cancel | post | /rpa/openapi/app/cancel | Cancels a request. |
queryAppApply | get | /rpa/openapi/app/ queryAppApply | You can retrieve the requested app. |
Tasks
Name | Method | Path | Description |
createTaskSchedule | post | /rpa/openapi/task/createTaskSchedule | Creates a scheduled task. |
createServiceTask | post | /rpa/openapi/task/createServiceTask | Creates a service task. |
queryTaskStatus | get | /rpa/openapi/task/queryTaskStatus | Queries the status of a task. |
queryServiceResult | get | /rpa/openapi/task/queryServiceResult | Queries the result of a task. |
terminalTask | post | /rpa/openapi/task/terminalTask | Stops a task by its taskUuid. |
queryTaskSchedules | get | /rpa/openapi/task/queryTaskSchedules | Queries the list of scheduled tasks. |
queryLogs | get | /rpa/api/ak/server/task/queryLogs | Retrieves the operational logs for a scheduled task. |
queryTaskScheduleBylientId | get | /rpa/api/ak/server/task/queryTaskScheduleByClientId | Retrieves a scheduled task by the client's unique identifier. |
queryTaskByClientId | get | /rpa/api/ak/server/task/queryTaskByClientId | Retrieves a task by the client's unique identifier. |