Device Pool API

A device pool is a logical grouping of devices that is used by a Bot Runner to distribute and manage the running of unattended bots. Use the Device Pool APIs to retrieve a list of device pools, create, update, or delete a device pool. You must have device pool owner or device pool admin access to view and manage the device pools. To create a new device pool, you must have a role with the create device pool permissions.

All API calls must contain either an authentication token from Authentication API (generates JSON Web token) or a bearer token from OAuth services. You cannot use both together in an API.

Header: X-Authorization: <<authentication token>> or Authorization: Bearer <<bearer token>>

More information: https://helloreverb.com

Contact Info: hello@helloreverb.com

Version: 2.0.0

All rights reserved

http://apache.org/licenses/LICENSE-2.0.html

Access

APIKey KeyParamName:X-Authorization KeyInQuery:false KeyInHeader:true

Methods

Models

Table of Contents

DevicePool

Up

delete /pools/{id}

Delete a pool (poolsIdDelete)

Use this endpoint to delete an existing pool. You must have the AAE_Pool Admin role to delete a pool. You must specify the device pool ID. To view the device pool ID, use the pools/list endpoint.

Path parameters

id (required)

Path Parameter — ID of the device pool format: int64

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

204

Return 'nocontent'

404

Not Found. ErrorMessage

500

Server error. Error

Up

get /pools/{id}

List specific device pool (poolsIdGet)

Use this endpoint to retrieve details of a specific device pool. You must specify the device pool ID. To view the device pool ID, use the /pools/list endpoint.

Path parameters

id (required)

Path Parameter — ID of the pool format: int64

Return type

DevicePoolResponse

Example data

Content-Type: application/json

{
  "tenantUuid" : "4090a32b-79c1-4fd8-b88a-b1ea8c994cb0",
  "deviceIds" : 26,
  "updatedBy" : 97,
  "ownerIds" : 97,
  "timeSlice" : 5,
  "description" : "Group of unattended Bot machines",
  "automationScheme" : "ROUND_ROBIN",
  "updatedOn" : "2022-08-29T06:03:26.026+0000",
  "createdOn" : 0,
  "timeSliceUnit" : "MINUTES",
  "detailedStatus" : "ALL_CONNECTED",
  "createdBy" : 97,
  "consumerIds" : [ ],
  "name" : "My_device_pool",
  "tenantId" : "5",
  "id" : 5,
  "status" : "CONNECTED"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Returns details of the specific device pool DevicePoolResponse

400

Bad Request. Error

401

Authentication required. Error

404

Not Found. ErrorMessage

500

Server error. Error

Up

put /pools/{id}

Update a device pool (poolsIdPut)

Use this endpoint to update a device pool. A successfully completed response returns the details of the updated pool. You must specify the device pool ID. To view the device pool ID, use the /pools/list endpoint.

Path parameters

id (required)

Path Parameter — ID of the pool format: int64

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body DevicePoolRequest (required)

Body Parameter —

Return type

DevicePoolResponse

Example data

Content-Type: application/json

{
  "tenantUuid" : "4090a32b-79c1-4fd8-b88a-b1ea8c994cb0",
  "deviceIds" : 26,
  "updatedBy" : 97,
  "ownerIds" : 97,
  "timeSlice" : 5,
  "description" : "Group of unattended Bot machines",
  "automationScheme" : "ROUND_ROBIN",
  "updatedOn" : "2022-08-29T06:03:26.026+0000",
  "createdOn" : 0,
  "timeSliceUnit" : "MINUTES",
  "detailedStatus" : "ALL_CONNECTED",
  "createdBy" : 97,
  "consumerIds" : [ ],
  "name" : "My_device_pool",
  "tenantId" : "5",
  "id" : 5,
  "status" : "CONNECTED"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Details of the device pool updated. DevicePoolResponse

400

Bad Request. Error

401

Authentication required. Error

404

Not Found. ErrorMessage

500

Server error. Error

Up

post /pools/list

List of device pools (poolsListPost)

Use this endpoint to retrieve device pools that are available for you. You can send an API request with or without filter parameters. An API request without any filter parameters specified, retrieves details of all the device pools. You can use the filter parameters to retrieve specific device pools as well. For more information, see <a href="https://docs.automationanywhere.com/bundle/enterprise-v2019/page/enterprise-cloud/topics/control-room/control-room-api/cloud-api-filter-request.html">Filtering, pagination, and sorting</a>.

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body FilterRequest (required)

Body Parameter —

Return type

DevicePoolsResponse

Example data

Content-Type: application/json

{
  "page" : {
    "totalFilter" : 1,
    "total" : 1,
    "offset" : 0,
    "list" : [ {
      "deviceIds" : 26,
      "detailedStatus" : "ALL_CONNECTED",
      "ownerIds" : 97,
      "deviceCount" : 2,
      "name" : "My_device_pool",
      "id" : 8,
      "automationCount" : 6,
      "status" : "CONNECTED"
    }, {
      "deviceIds" : 26,
      "detailedStatus" : "ALL_CONNECTED",
      "ownerIds" : 97,
      "deviceCount" : 2,
      "name" : "My_device_pool",
      "id" : 8,
      "automationCount" : 6,
      "status" : "CONNECTED"
    } ]
  }
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Returns list of device pools available to the user DevicePoolsResponse

400

Bad Request. Error

401

Authentication required. Error

404

Not Found. ErrorMessage

500

Server error. Error

Up

post /pools

Create a device pool (poolsPost)

Use this endpoint to create a device pool. A successfully completed response returns details of the device pool created. You must have the AAE_Pool_Admin role to create a device pool.

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body DevicePoolRequest (required)

Body Parameter —

Return type

DevicePoolResponse

Example data

Content-Type: application/json

{
  "tenantUuid" : "4090a32b-79c1-4fd8-b88a-b1ea8c994cb0",
  "deviceIds" : 26,
  "updatedBy" : 97,
  "ownerIds" : 97,
  "timeSlice" : 5,
  "description" : "Group of unattended Bot machines",
  "automationScheme" : "ROUND_ROBIN",
  "updatedOn" : "2022-08-29T06:03:26.026+0000",
  "createdOn" : 0,
  "timeSliceUnit" : "MINUTES",
  "detailedStatus" : "ALL_CONNECTED",
  "createdBy" : 97,
  "consumerIds" : [ ],
  "name" : "My_device_pool",
  "tenantId" : "5",
  "id" : 5,
  "status" : "CONNECTED"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Details of the device pool created. DevicePoolResponse

400

Bad Request. Error

401

Authentication required. Error

404

Not Found. ErrorMessage

500

Server error. Error

Models

Methods

Table of Contents

DevicePoolRequest
DevicePoolResponse
DevicePoolSnapshot
DevicePoolsResponse
Error
ErrorMessage
Filter
FilterRequest
PageRequest
Sort

`DevicePoolRequest` Up

id (optional)

Integer ID of the pool, required only for updating a pool

example: 8

name (optional)

String Name of the device pool you want to create

example: My_device_pool

description (optional)

String Description of the pool

example: Group of unattended Bot machines

automationScheme (optional)

String Automation scheme associated with the pool. ROUND_ROBIN runs your automations at equal time intervals. PRIORITY automations run based on a priority defined in the priority table.

Enum:

AUTOMATION_SCHEME_UNKNOWN

ROUND_ROBIN

PRIORITY

timeSlice (optional)

Integer Time interval specified for running the Bots in ROUND_ROBIN scheme

example: 5

timeSliceUnit (optional)

String Time slice specified in SECONDS, MINUTES, or HOURS

Enum:

TIME_SLICE_UNIT_UNKNOWN

SECONDS

MINUTES

HOURS

deviceIds (optional)

array[Integer] Array of integers indicating the devices in the pool

example: 26

ownerIds (optional)

array[Integer] Array of integers indicating the owners of the pool

example: 97

consumerIds (optional)

array[Integer] Array of integers indicating the consumer roles associated with the pool

example: []

`DevicePoolResponse` Up

id (optional)

Integer ID of the device pool created

example: 5

name (optional)

String Name of the device pool

example: My_device_pool

description (optional)

String Description of the pool

example: Group of unattended Bot machines

automationScheme (optional)

String automation scheme associated with the pool

Enum:

AUTOMATION_SCHEME_UNKNOWN

ROUND_ROBIN

PRIORITY

example: ROUND_ROBIN

status (optional)

String Status of the created pool

Enum:

POOL_STATUS_UNKNOWN

CONNECTED

DISCONNECTED

OFFLINE

example: CONNECTED

timeSlice (optional)

Integer Time interval specified for running the Bots in ROUND_ROBIN scheme

example: 5

timeSliceUnit (optional)

String Time slice specified in SECONDS, MINUTES, or HOURS

Enum:

TIME_SLICE_UNIT_UNKNOWN

SECONDS

MINUTES

HOURS

example: MINUTES

deviceIds (optional)

array[Integer] Array of integers indicating the devices in the pool

example: 26

ownerIds (optional)

array[Integer] Array of integers indicating the owners of the pool

example: 97

consumerIds (optional)

array[Integer] Array of integers indicating the roles associated with the pool

example: []

detailedStatus (optional)

String Detailed status of all the devices in the pool

Enum:

POOL_DEVICES_STATUS_UNKNOWN

ALL_CONNECTED

ALL_DISCONNECTED

SOME_CONNECTED

OFFLINE

example: ALL_CONNECTED

updatedBy (optional)

Integer ID of the user who last modified this pool

example: 97

updatedOn (optional)

String Time at which the pool was last updated

example: 2022-08-29T06:03:26.026+0000

createdBy (optional)

Integer ID of the user who created this pool

example: 97

createdOn (optional)

Integer Time at which the pool was created

tenantUuid (optional)

String The universally unique identifier (UUID) of the tenant. This UUID is used for accessing the tenant via the API.

example: 4090a32b-79c1-4fd8-b88a-b1ea8c994cb0

tenantId (optional)

String The unique identifier for the tenant and is based on the tenant name. The tenant ID is assigned to the tenant's resources.

example: 5

`DevicePoolSnapshot` Up

id (optional)

Integer ID of the device pool

example: 8

name (optional)

String Name of the device pool

example: My_device_pool

status (optional)

String Status of the device pool

Enum:

POOL_STATUS_UNKNOWN

CONNECTED

DISCONNECTED

OFFLINE

example: CONNECTED

detailedStatus (optional)

String Detailed status of all devices in the pool

Enum:

POOL_DEVICES_STATUS_UNKNOWN

ALL_CONNECTED

ALL_DISCONNECTED

SOME_CONNECTED

OFFLINE

example: ALL_CONNECTED

automationCount (optional)

Integer Number of automations associated with this pool

ownerIds (optional)

array[Integer] Array of integers indicating the owners of the pool

example: 97

deviceCount (optional)

Integer Number of devices in the pool

example: 2

deviceIds (optional)

array[Integer] Array of integers indicating the devices in the pool

example: 26

`DevicePoolsResponse` Up

page (optional)

Object

`Error` Up

code (optional)

String Error code

message (optional)

String Error Message

`ErrorMessage` Up

message (optional)

String Error Message

`Filter` Up

Filters the result based on operator, field, or value.

operator (optional)

String Operator

Enum:

NONE

lt

le

eq

ne

ge

gt

substring

and

or

not

operands (optional)

array[Filter]

example: {operator=substring, field=status, value=CONNECTED}

field (optional)

String Filtering field can be either name, lastModified, path, or folder.

example: name

value (optional)

String Filter value

example: My_device_pool

`FilterRequest` Up

Filter request, which includes filtering, sorting, and pagination rules

filter (optional)

Filter

sort (optional)

array[Sort] Sort directions

page (optional)

PageRequest

`PageRequest` Up

Pagingation rules, allows you to filter based on desired page

offset (optional)

Integer Page starting index

length (optional)

Integer Page length

example: 100

`Sort` Up

By default, search results are sorted in descending order with respect to their IDs. An alternative sorting is specified by using the sort query parameter.

field (optional)

String Field name to sort by

example: name

direction (optional)

String Sorting direction

Enum:

asc

desc