List available unattended Bot Runners API

Return a list of available users with unattended Bot Runner licenses. This endpoint returns the user id, which is a numeric value that is used by APIs to identify users.

先决条件

注： You can view the Control Room APIs in the Community Edition, but API functionality is limited. You need a licensed Automation 360 Edition to access the full functionality of the APIs.

All API calls must contain an authentication token in the request header. Use the Authentication API to generate a JSON web token. See Authentication API.
You must be assigned a custom role that is associated with a Run As user device.

过程

Add the authentication token to the request header.
Use the POST method and endpoint URL: <your_control_room_url>/v1/devices/runasusers/list.
Request body:
```
{
   "sort":[
      {
         "field":"username",
         "direction":"asc"
      }
   ],
   "filter":{},
   "page":{}
}
```
Filtering, pagination, and sorting

Send the request.

Response body: In a successful request, this endpoint returns the following data:

id: a unique numeric identifier for a user with the Bot Runner license.
device: if the user is configured with a default device, the device name is returned. For example, DESKTOP-DBO6SIE. Otherwise, this parameter returns the message Picked at run time, indicating that a device must be selected from a device pool in order to run a bot.

{
   "page":{
      "offset":0,
      "total":6,
      "totalFilter":6
   },
   "list":[
      {
         "id":"9",
         "username":"ubr01_rt",
         "device":"DESKTOP-DBO6SIE",
         "deviceId":"3"
      },
      {
         "id":"10",
         "username":"ubr02_rt",
         "device":"DESKTOP-DBO6SIE",
         "deviceId":"3"
      },
      {
         "id":"11",
         "username":"ubr03_rt",
         "device":"DESKTOP-DBO6SIE",
         "deviceId":"3"
      },
      {
         "id":"12",
         "username":"ubr04_rt",
         "device":"Picked at run time",
         "deviceId":"-1"
      },
      {
         "id":"13",
         "username":"ubr05_rt",
         "device":"Picked at run time",
         "deviceId":"-1"
      },
      {
         "id":"14",
         "username":"ubr06_rt",
         "device":"Picked at run time",
         "deviceId":"-1"
      }
   ]
}

后续步骤

If you are performing the steps to deploy a bot or to create an automation schedule, and the user associated with the Bot Runner license does not have a default device assigned or if you want to select a different device, perform this task: List device pools API.

To deploy a bot that runs on the default device assigned to the Bot Runner user, perform this task: Bot deployment - V3.

To create an automation schedule with a bot that runs on the default device assigned to the Bot Runner user, perform this task: Schedule bot to run API.