API overview
API overview
You can use the following APIs for service-oriented robots.
These APIs apply only to public cloud RPA. They are not available in offline RPA deployments.
Service-oriented robots
Parameter | Type | Path | Description |
GET | rpa/openapi/raas/resource/ListRobots | Lists service-oriented robots. | |
POST | rpa/openapi/raas/resource/RebootRobot | Reboots a service-oriented robot. | |
POST | rpa/openapi/raas/resource/AddRobots | Adds one or more service-oriented robots. | |
POST | rpa/openapi/raas/resource/DeleteRobots | Deletes one or more service-oriented robots. | |
POST | rpa/openapi/raas/resource/StopRobots | Stops one or more service-oriented robots. | |
GET | rpa/openapi/raas/resource/GetAuthCode | Gets the information required for a remote connection. |
Tasks
Parameter | Type | Path | Description |
POST | rpa/openapi/raas/task/CreateTask | Creates a task. | |
GET | rpa/openapi/raas/task/ListTaskDetails | Lists task details. | |
GET | rpa/openapi/raas/task/ListTasks | Lists tasks. | |
POST | rpa/openapi/raas/task/StopTasks | Stops one or more tasks. | |
POST | rpa/openapi/raas/task/UpdateTaskPriority | Updates the priority of a task. | |
POST | rpa/openapi/raas/task/ClearTaskQueue | Clears the task queue. |
Service-oriented robot packs
Parameter | Type | Path | Description |
GET | rpa/openapi/raas/pack/ListPacks | Lists packs. | |
GET | rpa/openapi/raas/pack/GetPack | Gets the details of a pack. | |
POST | rpa/openapi/raas/pack/CreatePack | Creates a pack. | |
POST | rpa/openapi/raas/pack/UpdatePack | Updates a pack. | |
POST | rpa/openapi/raas/pack/DeletePack | Deletes a pack. |
Asset variables
Parameter | Type | Path | Description |
POST | rpa/openapi/asset-variable/CreateAssetVariable | Creates an asset variable. | |
POST | rpa/openapi/asset-variable/UpdateAssetVariable | Updates an asset variable. | |
POST | rpa/openapi/asset-variable/DeleteAssetVariable | Deletes one or more asset variables. | |
POST | rpa/openapi/asset-variable/ListAssetVariables | Lists asset variables. |
Applications
Parameter | Type | Path | Description |
GET | /rpa/openapi/app/ListApplications | Lists applications the user can use. |