Bot Execution Orchestrator API

The V2 Bot Execution Orchestrator API is used to monitor devices. The searchable fields for monitoring devices includes:
Searchable fields for devices:

hostName: The host name of the device configured as a Bot Runner. If a naming convention is used for host names, searching on a unique substring in the host name is an effective way to identify Bot Runner devices
userId: The unique numeric identification for a specific user also identifies the Bot Runner device. Unique user naming conventions can be used to identify users and devices that are licensed and configured as Bot Runners.

Prerequisites

Control Room administrator or a user with View and Manage Scheduled Activity feature permissions, you can monitor the bot progress using a set of Control Room APIs.

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 file example: -H X-Authorization <authentication token> or Authorization:Bearer <bearer token>

More information: https://helloreverb.com

Contact Info: hello@helloreverb.com

Version: 1.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

Automations

post /devices/list

Automations

Up

post /devices/list

Lists devices (devicesListPost)

Use this API to retrieve a list of devices that are available for bot deployment. The device ids retreieved from it can be passed to the deployment API. Additional filtering, ordering and pagination rules can be requested.

Consumes

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

application/json

Request body

body FilterRequest (required)

Body Parameter —

Return type

DeviceResponse

Example data

Content-Type: application/json

{
  "page" : {
    "totalFilter" : 1,
    "total" : 4,
    "offset" : 0
  },
  "list" : [ {
    "hostName" : "ABLL01238",
    "updatedBy" : "21",
    "installationType" : "SYSTEM_WIDE",
    "lifespan" : "PERSISTENT",
    "defaultUsers" : [ {
      "domain" : "SampleDomain",
      "id" : "916",
      "username" : "joedoe"
    }, {
      "domain" : "SampleDomain",
      "id" : "916",
      "username" : "joedoe"
    } ],
    "logConfiguration" : {
      "logCollectorEnabled" : false,
      "logLevel" : "INFO",
      "numberOfLogFile" : "10",
      "level" : "INFO",
      "logFileSize" : "10"
    },
    "id" : "33",
    "updatedOn" : "2022-11-15T03:09:04.279786Z",
    "type" : "SINGLE_USER",
    "poolName" : "DevicePool1",
    "status" : "CONNECTED"
  }, {
    "hostName" : "ABLL01238",
    "updatedBy" : "21",
    "installationType" : "SYSTEM_WIDE",
    "lifespan" : "PERSISTENT",
    "defaultUsers" : [ {
      "domain" : "SampleDomain",
      "id" : "916",
      "username" : "joedoe"
    }, {
      "domain" : "SampleDomain",
      "id" : "916",
      "username" : "joedoe"
    } ],
    "logConfiguration" : {
      "logCollectorEnabled" : false,
      "logLevel" : "INFO",
      "numberOfLogFile" : "10",
      "level" : "INFO",
      "logFileSize" : "10"
    },
    "id" : "33",
    "updatedOn" : "2022-11-15T03:09:04.279786Z",
    "type" : "SINGLE_USER",
    "poolName" : "DevicePool1",
    "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 a list of devices or a blank list as per filter conditions specified. DeviceResponse

400

Bad Request. Error

401

Authentication required. Error

500

Server error. Error

Models

Methods

`Device` Up

id (optional)

String Id of the device

example: 33

type (optional)

String Device type

Enum:

SINGLE_USER

MULTIPLE_USERS

hostName (optional)

String Host name of the machine where the device is logged in

example: ABLL01238

poolName (optional)

String Name of the device pool

example: DevicePool1

updatedBy (optional)

String Id of the user who made a latest update on the object

example: 21

updatedOn (optional)

String The latest update of the object

example: 2022-11-15T03:09:04.279786Z

status (optional)

String Status of the device

Enum:

CONNECTED

DISCONNECTED

OFFLINE

defaultUsers (optional)

array[defaultUsers] Users that have access to the device

lifespan (optional)

String Lifespan of the device

Enum:

PERSISTENT

TEMPORARY

installationType (optional)

String The installation type

Enum:

SYSTEM_WIDE

USER_SPECIFIC

logConfiguration (optional)

logConfiguration

`DeviceResponse` Up

page (optional)

PageResponse

list (optional)

array[Device] list of devices.

`Error` Up

code (optional)

String Error code

message (optional)

String Error Message

`ErrorMessage` Up

message (optional)

String Error Message

`Filter` Up

Filter rules

operator (optional)

String Operator

Enum:

and

lt

le

eq

ne

ge

gt

substring

NONE

or

not

operands (optional)

array[Ops]

example: [{operator=eq, field=updatedBy, value=10}, {operator=eq, field=status, value=CONNECTED}]

`FilterRequest` Up

Filter request, which includes filtering, sorting and pagination rules

filter (optional)

Filter

sort (optional)

array[Sort] Sort directions

page (optional)

PageRequest

`Ops` Up

Operands rules

operator (optional)

String Operator

Enum:

gt

lt

le

eq

ne

ge

and

substring

NONE

or

not

`PageRequest` Up

Pagingation rules

offset (optional)

Integer Page starting index

example: 0

length (optional)

Integer Page length

example: 1000

`PageResponse` Up

Pagingation response

offset (optional)

Integer Page starting index

example: 0

total (optional)

Integer Total number of items

example: 4

totalFilter (optional)

Integer Total number of items matching filter

example: 1

`SearchFileFilter` Up

Filter rules

operator (optional)

String Operator

Enum:

NONE

lt

le

eq

ne

ge

gt

substring

and

or

not

operands (optional)

array[SearchFileFilter]

field (optional)

String Filtering field could be either name,directory,lastModified,createdOn or path.

value (optional)

String Filter value

`SearchFileFilterRequest` Up

Filter request, which includes filtering, sorting and pagination rules

fields (optional)

array[String] Fields to be returned

filter (optional)

Filter

sort (optional)

array[Sort] Sort directions

page (optional)

PageRequest

`Sort` Up

Sorting rules

field (optional)

String Field name to sort by

example: name

direction (optional)

String Sorting direction

Enum:

asc

desc

example: asc

`defaultUsers` Up

id (optional)

String Id of default user to the device

example: 916

username (optional)

String Username of the default user

example: joedoe

domain (optional)

String Domain name of the user

example: SampleDomain

`logConfiguration` Up

logLevel (optional)

String Different log levels.

Enum:

INFO

DEBUG

TRACE

logFileSize (optional)

String Size of the log file

example: 10

numberOfLogFile (optional)

String Number of log files

example: 10

logCollectorEnabled (optional)

Boolean A flag to indicate if the log collector is enabled or not

example: false

level (optional)

String Shows the log levels

Enum:

INFO

DEBUG

TRACE

Automation 360

Bot Execution Orchestrator API