Bot Deploy API (V3)

Use this Control room API to deploy bots from the public workspace to Bot Runner devices. To deploy bots you must have the following permissions.

View and Run my bots feature permission
Run and schedule permissions for the folders that contain the bots
Access to Bot Runner licensed users
Access to either a default device or a device pool

This API supports callback URL for environments that have both the Control Room and callback server on the same network. 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: 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 /automations/deploy

Automations

Up

post /automations/deploy

Deploy a bot using runAs Users (automationsDeployPost)

<p> Use this endpoint to deploy a bot by using runAs Users. To deploy a bot, the following device selection criteria is applied. </p> <li>If <b>poolIds</b> are not provided, the default device associated with runAs user is used to deploy the bot. </li> <li>If <b>poolIds</b> are provided and <b>overrideDefaultDevice</b> is set to false, the default device associated with runAs user is preffered if any are available. Otherwise, the device is picked from the pool to deploy bot.</li> <li>If <b>poolIds</b> are provided and <b>overrideDefaultDevice</b> is set to true, the device is picked from the pool to deploy bot. </li> <li>If the device is not available or the user is not available then the deployment is queued.</li> <p> <b>Note:</b> Bot deploy request can be made without any input fields. If you specify inputs, make sure that the bot to successfully receive these mapped in values, the variable for that bot must be marked as input. Additionally, the name of the variable in the bot has to match the value that is being mapped in the request body.</p> <p>Example value specified below is for Dictionary Bot Input. You can view the other Bot input types in the <b>Models</b> section at the end of the swagger.

Consumes

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

application/json

Request body

body DeployRequest (required)

Body Parameter —

Return type

DeployResponse

Example data

Content-Type: application/json

{
  "deploymentId" : "340a2949-aa44-41ab-af9b-f9343ae2581c"
}

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

A deployment ID is returned that can be used to check the status of deployment using the callback URL. DeployResponse

400

Bad Request. Error

401

Authentication required. Error

404

Not Found. ErrorMessage

500

Server error. Error

Models

Methods

Table of Contents

AttributeType
AutomationPriority
BotValue
CallBackResponse
CallbackInfo
Coordinate
CredentialObject
DeployRequest
DeployResponse
Dictionary
Dictprop
Error
ErrorMessage
HotKey
HotKeyModifierKey
NestedStringValue
Point
PointImageCapture
Property
Record
Rectangle
RectangleImageCapture
Region
Row
Schema
Table
TaskbotFile
TaskbotInput
TaskbotOutput
UIObject
UIObjectControlType
UIObjectSelectionCriterion
UIObjectTechnologyType
Value
Window
WindowLocation
WindowPreset
WindowSize
WindowValue
botinput
iTestList

`AttributeType` Up

`AutomationPriority` Up

`BotValue` Up

type (optional)

String

example: STRING

string (optional)

String

example: value1

`CallBackResponse` Up

deploymentId (optional)

String This is same as the deployementId returned when deployment triggered.

userId (optional)

Integer The runAs UserId which used to run bot

deviceId (optional)

Integer The device where the bot got executed.

status (optional)

String

Enum:

RUN_COMPLETED

RUN_FAILED

RUN_ABORTED

RUN_TIMED_OUT

botOutput (optional)

map[String, Value]

`CallbackInfo` Up

Callback URL & Headers.

url

String Callback API URL.

headers (optional)

map[String, String]

`Coordinate` Up

x (optional)

Value

y (optional)

Value

capture (optional)

PointImageCapture

`CredentialObject` Up

name (optional)

String

lockerName (optional)

String

attributeName (optional)

String

`DeployRequest` Up

fileId

Integer File ID of the bot to be deployed.

example: 83

automationName (optional)

String Name of the automation being deployed.

example: Deploy_My_Bot

runAsUserIds

array[Integer]

callbackInfo (optional)

CallbackInfo

poolIds (optional)

array[Integer]

overrideDefaultDevice (optional)

Boolean Indicates whether to use default device or not. <li> This will be effective if the poolId(s) are provided. <li> If the value is set to false, the default device is preferred else device from the pool is picked.

botInput (optional)

botinput

runElevated (optional)

Boolean Whether to deploy the bot using elevated permissions or not.

numOfRunAsUsersToUse (optional)

Integer Used to indicate how many run as users should be used from the list of runAsUserIds provided. <li> System will pick the specified number of runAsUsers with the least number of tasks queued for the user at the moment of deploy request. </li> <li> If 0 then all the users will be used.</li> <li> If the number is greater than the number of runAsUsers provided or less than 0 it will error out.</li>