Automations

boolean (optional)

Boolean

example: true

`BotValue` Up

type (optional)

example: STRING

string (optional)

Credential_botInput_myCredentialObjectInput

example: value1

`CallbackInfo` Up

Callback URL & Headers.

url

String Callback API URL.

headers (optional)

map[String, String]

`Coordinate` Up

botInput (optional)

Coordinate_botInput

`Coordinate_botInput` Up

Example of Coordinate Bot Input

myCoordinateInput (optional)

Object

`Credential` Up

botInput (optional)

Credential_botInput

`Credential_botInput` Up

Example of CredentialObject Bot Input

myCredentialObjectInput (optional)

`Credential_botInput_myCredentialObjectInput` Up

name (optional)

example: MyCredential

lockerName (optional)

example: MyLocker

attributeName (optional)

DateTime_botInput_dt_input1

example: Username

`DateTime` Up

botInput (optional)

DateTime_botInput

`DateTime_botInput` Up

Example of DateTime Bot Input

dt_input1 (optional)

dt_input2 (optional)

DateTime_botInput_dt_input2

`DateTime_botInput_dt_input1` Up

type (optional)

example: DATETIME

string (optional)

example: 2025-04-27T00:15:00-06:00[USA/New York]

`DateTime_botInput_dt_input2` Up

type (optional)

example: DATETIME

string (optional)

example: 2025-04-27T00:15:05-06:00[USA/New York]

`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.

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.

automationPriority (optional)

AutomationPriority

botLabel (optional)

String label for the bot being deployed.

hideBotAgentUi (optional)

Boolean <p>Indicates whether to show running progress UI while bot is running.</p> <ul> <li>Default will be true, which indicates UI will not be visible.</li> </ul>

`DeployResponse` Up

deploymentId (optional)

String Deployment ID created.

example: 340a2949-aa44-41ab-af9b-f9343ae2581c

`Dictionary` Up

botInput (optional)

Dictionary_botInput

`DictionaryProperties` Up

key (optional)

Dictionary_botInput_myDictionaryInput

example: key1

value (optional)

BotValue

`Dictionary_botInput` Up

Example of Dictionary Bot Input

myDictionaryInput (optional)

`Dictionary_botInput_myDictionaryInput` Up

type (optional)

array[DictionaryProperties]

dictionary (optional)

`Error` Up

code (optional)

String Error code

message (optional)

String Error Message

`ErrorMessage` Up

message (optional)

String Error Message

`File` Up

botInput (optional)

File_botInput

`File_botInput` Up

Example of File Bot Input

myFileInput (optional)

File_botInput_myFileInput

`File_botInput_myFileInput` Up

type (optional)

HotKey_botInput_myHotKeyInput

string (optional)

String Base64 encoded file content

example: SGVsbG8gV29ybGQ=

fileName (optional)

String Name of the file

example: hello.txt

`HotKey` Up

botInput (optional)

HotKey_botInput

`HotKeyModifierKey` Up

`HotKey_botInput` Up

Example of HotKey Bot Input

myHotKeyInput (optional)

`HotKey_botInput_myHotKeyInput` Up

key (optional)

Iterator_botInput_myIteratorInput

example: A

modifierKeys (optional)

array[HotKeyModifierKey]

`Iterator` Up

botInput (optional)

Iterator_botInput

`Iterator_botInput` Up

Example of Iterator Bot Input

myIteratorInput (optional)

`Iterator_botInput_myIteratorInput` Up

type (optional)

List_botInput_myListInput

start (optional)

Integer Start value of the iterator

example: 1

end (optional)

Integer End value of the iterator

example: 10

step (optional)

Integer Step value of the iterator

example: 2

`List` Up

botInput (optional)

List_botInput

`List_botInput` Up

Example of List Bot Input

myListInput (optional)

`List_botInput_myListInput` Up

type (optional)

list (optional)

array[BotValue]

`Number` Up

botInput (optional)

Number_botInput

`Number_botInput` Up

Example of Number Bot Input

sInput1 (optional)

Number_botInput_sInput1

sInput2 (optional)

Number_botInput_sInput2

`Number_botInput_sInput1` Up

type (optional)

example: NUMBER

string (optional)

BigDecimal

example: 123

`Number_botInput_sInput2` Up

type (optional)

Record_botInput_myRecordInput

example: NUMBER

string (optional)

BigDecimal

example: 456

`Record` Up

botInput (optional)

Record_botInput

`Record_botInput` Up

Example of Record Bot Input

myRecordInput (optional)

`Record_botInput_myRecordInput` 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)

Region_botInput_myRegionInput

screenshotRectangle (optional)

Rectangle

thumbnailRectangle (optional)

Rectangle

securelyRecorded (optional)

Boolean format: boolean

`Region` Up

botInput (optional)

Region_botInput

`Region_botInput` Up

Example of Region Bot Input

myRegionInput (optional)

`Region_botInput_myRegionInput` Up

x (optional)

y (optional)

width (optional)

height (optional)

capture (optional)

RectangleImageCapture

`Row` Up

values (optional)

array[Value]

example: value1

`Schema` Up

name (optional)

example: Bot

type (optional)

`String` Up

botInput (optional)

String_botInput

`String_botInput` Up

Example of String Bot Input

sInput1 (optional)

String_botInput_sInput1

sInput2 (optional)

String_botInput_sInput2

`String_botInput_sInput1` Up

type (optional)

example: STRING

string (optional)

example: Test Values1

`String_botInput_sInput2` Up

type (optional)

example: STRING

string (optional)

Table_botInput_myTableInput

example: Test Values2

`Table` Up

botInput (optional)

Table_botInput

`Table_botInput` Up

Example of Table Bot Input

myTableInput (optional)

`Table_botInput_myTableInput` Up

schema (optional)

array[Schema]

rows (optional)

array[Row]

`TaskBot` Up

botInput (optional)

TaskBot_botInput

`TaskBotArgument` Up

name (optional)

example: Input1

value (optional)

type (optional)

TaskBot_botInput_myTaskBotInput

`TaskBot_botInput` Up

Example of TaskBot Input

myTaskBotInput (optional)

`TaskBot_botInput_myTaskBotInput` Up

id (optional)

example: f7a7e3b0-4a2a-4a1a-8a0a-0a0a0a0a0a0a

name (optional)

example: My Task Bot

version (optional)

example: 1.0

repositoryPath (optional)

example: \My Bots\TaskBot1.atmx

runAsUser (optional)

example: MyUser

arguments (optional)

array[TaskBotArgument]

`UIObject` Up

botInput (optional)

UIObject_botInput

`UIObjectControlType` Up

`UIObjectSelectionCriterion` Up

enabled (optional)

Boolean format: boolean

value (optional)

UIObject_botInput_myUIObjectInput

`UIObjectTechnologyType` Up

`UIObject_botInput` Up

Example of UIObject Bot Input

myUIObjectInput (optional)

`UIObject_botInput_myUIObjectInput` Up

blob (optional)

byte[] format: byte

controlType (optional)

UIObjectControlType

technologyType (optional)

UIObjectTechnologyType

criteria (optional)

map[String, UIObjectSelectionCriterion]

capture (optional)

RectangleImageCapture

`Value` Up

type (optional)

Variable_botInput_myVariableInput

dictionary (optional)

array[Dictionary]

`Variable` Up

botInput (optional)

Variable_botInput

`Variable_botInput` Up

Example of Variable Bot Input

myVariableInput (optional)

`Variable_botInput_myVariableInput` Up

type (optional)

string (optional)

String Value of the variable

example: myVariableValue

variableName (optional)

String Name of the variable

example: myVariable

`Window` Up

botInput (optional)

Window_botInput

`WindowLocation` Up

top (optional)

Integer format: int32

left (optional)

Integer format: int32

`WindowPreset` Up

`WindowSize` Up

height (optional)

Integer format: int32

example: 800

width (optional)

Integer format: int32

example: 600

`Window_botInput` Up

Example of Window Bot Input

name (optional)

example: Browser

path (optional)

example: https://www.automationanywhere.com/

class (optional)