Bot Deploy API (v4)

y (optional)

capture (optional)

PointImageCapture

`CredentialObject` Up

name (optional)

lockerName (optional)

attributeName (optional)

`DeployResponse` Up

deploymentId (optional)

String Deployment ID created.

example: 120a1243-a434-22aa-ab3f-f1123ae2523b

`DeploymentRequest` Up

botId

Integer Bot Id of bot to be deployed.

example: 21

automationName (optional)

String Name of the automation being deployed.

example: SampleBot

description (optional)

String Description of the automation being deployed.

example: My first bot deploy using api

botLabel (optional)

String Label for the bot being deployed.

runElevated (optional)

Boolean Specifies whether to deploy the bot with elevated permissions.

hideBotAgentUi (optional)

Boolean Specifies whether to hide the bot agent UI.

callbackInfo (optional)

CallbackInfo

automationPriority (optional)

AutomationPriority

botInput (optional)

botInput

`Dictionary` Up

key (optional)

value (optional)

`Error` Up

code (optional)

String Error code

message (optional)

String Error Message

`ErrorMessage` Up

message (optional)

String Error Message

`HeadlessRequest` Up

Headless deployments can be done on any device pool by the user

headlessRequest (optional)

headlessRequestObj

`HotKey` Up

key (optional)

modifierKeys (optional)

array[HotKeyModifierKey]

`HotKeyModifierKey` Up

`NestedStringValue` Up

type (optional)

string (optional)

expression (optional)

`Point` Up

x (optional)

Integer format: int32

y (optional)

Integer format: int32

`PointImageCapture` Up

thumbnailMetadataPath (optional)

screenshotMetadataPath (optional)

screenshotPoint (optional)

Point

screenshotX (optional)

Integer format: int32

screenshotY (optional)

Integer format: int32

screenshotWidth (optional)

Integer format: int32

screenshotHeight (optional)

Integer format: int32

securelyRecorded (optional)

Boolean format: boolean

`Property` Up

name (optional)

value (optional)

enabled (optional)

Boolean format: boolean

`Record` Up

schema (optional)

array[Schema]

values (optional)

array[Value]

`Rectangle` Up

x (optional)

Integer format: int32

y (optional)

Integer format: int32

width (optional)

Integer format: int32

height (optional)

Integer

`RectangleImageCapture` Up

thumbnailMetadataPath (optional)

screenshotMetadataPath (optional)

screenshotRectangle (optional)

Rectangle

thumbnailRectangle (optional)

Rectangle

securelyRecorded (optional)

Boolean format: boolean

`Region` Up

x (optional)

y (optional)

width (optional)

height (optional)

capture (optional)

RectangleImageCapture

`Row` Up

values (optional)

array[Value]

`Schema` Up

name (optional)

type (optional)

`Table` Up

schema (optional)

array[Schema]

rows (optional)

array[Row]

`TaskbotFile` Up

type (optional)

string (optional)

repository (optional)

Boolean format: boolean

expression (optional)

`TaskbotInput` Up

type (optional)

dictionary (optional)

array[Dictionary]

`TaskbotOutput` Up

type (optional)

map[String, UIObjectSelectionCriterion]

dictionary (optional)

Dictionary

`UIObject` Up

blob (optional)

byte[] format: byte

controlType (optional)

UIObjectControlType

technologyType (optional)

UIObjectTechnologyType

criteria (optional)

capture (optional)

RectangleImageCapture

`UIObjectControlType` Up

`UIObjectSelectionCriterion` Up

enabled (optional)

Boolean format: boolean

value (optional)

`UIObjectTechnologyType` Up

`UnattendedRequest` Up

Unattended deployments can be done on any devices associatged to the runAsUser

unattendedRequest (optional)

unattendedRequestObj

`Value` Up

type (optional)

expression (optional)

string (optional)

number (optional)

boolean (optional)

repository (optional)

variableName (optional)

packageId (optional)

packageName (optional)

iteratorId (optional)

iteratorName (optional)

conditionalId (optional)

conditionalName (optional)

table (optional)

Table

dictionary (optional)

array[Dictionary]

taskbotFile (optional)

TaskbotFile

taskbotInput (optional)

TaskbotInput

taskbotOutput (optional)

TaskbotOutput

window (optional)

Window

uiObject (optional)

UIObject

record (optional)

Record

exceptionName (optional)

credential (optional)

CredentialObject

uiObjectWindow (optional)

WindowValue

coordinate (optional)

Coordinate

thumbnailMetadataPath (optional)

screenshotMetadataPath (optional)

region (optional)

Region

properties (optional)

array[Property]

triggerName (optional)

file (optional)

NestedStringValue

formElementId (optional)

formElementType (optional)

formInstanceId (optional)

hotKey (optional)

HotKey

queueName (optional)

taskbotSelf (optional)

Boolean format: boolean

`Window` Up

name (optional)

path (optional)

class (optional)

handle (optional)

Long format: int64

isChild (optional)

Boolean format: boolean

location (optional)

WindowLocation

size (optional)

WindowSize

presetType (optional)

WindowPreset

`WindowLocation` Up

top (optional)

Integer format: int32

left (optional)

Integer format: int32

`WindowPreset` Up

`WindowSize` Up

height (optional)

Integer format: int32

width (optional)

Integer format: int32

`WindowValue` Up

type (optional)

window (optional)

Window

expression (optional)

`attendedRequestObj` Up

deploymentDeviceId (optional)

Integer unique id of the device on the which bot has to be executed.

queueDeployment (optional)

Boolean Specifies whether the deployment has to be queued

launchInChildWindow (optional)

Boolean Specifies whether the bot needs to launched in a child window on the device.

`botInput` Up

iTestList (optional)

iTestList

`headlessRequestObj` Up

numberOfExecutions (optional)

Integer Number of executions to run for a given Headless request.

sharedRunAsUserId (optional)

Integer RunAsUser's id to deploy bot. The bot will be deployed on 1 of the devices from the provided device pool(s)

example: 639

queueOnSlotsExhaustion (optional)

Boolean whether the deployment has to be queued

`iTestList` Up

type (optional)

list (optional)

array[iTestList_list]

example: [{"type":"STRING","string":"TestValues1"},{"type":"STRING","string":"TestValue2"}]

`iTestList_list` Up

type (optional)

string (optional)