Automations

example: STRING

string (optional)

example: value1

`Coordinate` Up

x (optional)

y (optional)

capture (optional)

PointImageCapture

`CredentialObject` Up

name (optional)

lockerName (optional)

attributeName (optional)

`DailyRecurrence` Up

Specify the daily interval to schedule the bot

interval (optional)

Integer format: int32

`DayOfWeek` Up

`Dictionary` Up

`Dictprop` Up

key (optional)

example: key1

value (optional)

BotValue

`Error` Up

code (optional)

String Error code

message (optional)

String Error Message

`ErrorMessage` Up

message (optional)

String Error Message

`Filter` Up

operator (optional)

FilterOperator

operands (optional)

array[Filter]

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

field (optional)

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

example: name

value (optional)

String Filter value

example: My bot_2.22.11.16.15.37.33.admin

`FilterOperator` Up

`FilterRequest` Up

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

filter (optional)

Filter

sort (optional)

array[Sort]

page (optional)

PageRequest

`HotKey` Up

key (optional)

modifierKeys (optional)

array[HotKeyModifierKey]

`HotKeyModifierKey` Up

`KeyValueItem` Up

key (optional)

value (optional)

`MonthOfYear` Up

`MonthlyDateRecurrence` Up

monthsOfYear (optional)

array[MonthOfYear]

dateOfMonth (optional)

Integer format: int32

`MonthlyWeekDayRecurrence` Up

monthsOfYear (optional)

array[MonthOfYear]

weekOfMonth (optional)

WeekOfMonth

dayOfWeek (optional)

DayOfWeek

`NestedNumberValue` Up

type (optional)

number (optional)

expression (optional)

`NestedStringValue` Up

type (optional)

string (optional)

expression (optional)

`PageRequest` Up

Pagination rules, allows you to filter based on desired page

offset (optional)

Integer Page starting index format: int32

length (optional)

Integer Page length format: int32

example: 100

`PageResponse` Up

offset (optional)

Integer format: int32

total (optional)

Integer format: int32

totalFilter (optional)

Integer format: int32

`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 format: int32

`RectangleImageCapture` Up

thumbnailMetadataPath (optional)

screenshotMetadataPath (optional)

screenshotRectangle (optional)

Rectangle

thumbnailRectangle (optional)

Rectangle

securelyRecorded (optional)

Boolean format: boolean

`RegexFile` Up

folder (optional)

NestedStringValue

name (optional)

RegexFileName

`RegexFileName` Up

type (optional)

list (optional)

array[NestedStringValue]

regexFlags (optional)

RegexFlags

`RegexFlags` Up

multiLine (optional)

Boolean format: boolean

dotAll (optional)

Boolean format: boolean

caseInsensitive (optional)

Boolean format: boolean

`Region` Up

x (optional)

y (optional)

width (optional)

height (optional)

capture (optional)

RectangleImageCapture

`RepeatOccurrence` Up

runEvery (optional)

Long Repeat schedule time format: int64

example: 2

timeUnit (optional)

TimeUnit

endTime (optional)

example: 23:59

`Row` Up

values (optional)

array[Value]

`ScheduleAutomationRequest` Up

name (optional)

String Name of the automation

example: My bot_2.22.11.16.15.37.33.admin

fileId (optional)

Long Unique ID of the file used for automation format: int64

example: 1163

fileName (optional)

String Name specified for the file

example: My bot_2

status (optional)

AutomationStatus

deviceIds (optional)

array[Long] Device IDs to schedule the automations format: int64

example: [97, 100]

description (optional)

String Text describing the automation

example: Schedule automation to run email bot.

rdpEnabled (optional)

Boolean Indicates if remote desktop is enabled format: boolean

scheduleType (optional)

ScheduleType

dailyRecurrence (optional)

DailyRecurrence

timeZone (optional)

String Time zone where the schedule is set

example: Asia/Calcutta

startDate (optional)

String Start date of the automation.

example: 2022-11-16

endDate (optional)

String End date of the automation.

example: 2022-12-16

startTime (optional)

String Start time of the automation.

example: 16:00

repeatEnabled (optional)

Boolean Run the schedule repeatedly

repeatOccurrence (optional)

RepeatOccurrence

runAsUserIds (optional)

array[Long] Specify all the run as user IDs format: int64

example: [133, 170]

botInput (optional)

botinput

poolIds (optional)

array[Long] The device pool IDs to schedule the automation format: int64

example: [9, 10]

workspaceName (optional)

String Private or public workspace the Bot resides

example: public

overrideDefaultDevice (optional)

Boolean If deploying to the default device, set this parameter to false.

misfireScheduleConfig (optional)

Boolean Controls how missed schedule executions are handled. This can occur if the scheduler is unable to run a job at its intended time due to unforeseen circumstances. If set to true, it will attempt to re-run the missed job as soon as possible. If set to false (default), it will disregard the missed execution and move on to the next scheduled time for the job.

numOfRunAsUsersToUse (optional)

Long Total run as users to use for the automation format: int64

example: 2

runElevated (optional)

Boolean Specifies whether to deploy the bot with elevated permissions.

automationPriority (optional)

AutomationPriority

botLabel (optional)

String Label specified for the bot.

example: Test Bot

`ScheduleAutomationResponse` Up

id (optional)

Long Unique ID of the automation format: int64

example: 3

name (optional)

String Name specified for the automation

example: My bot_2.22.11.16.15.37.33.admin

fileId (optional)

Long Unique ID of the file used for automation format: int64

example: 1163

status (optional)

AutomationStatus

deviceIds (optional)

array[Long] Device IDs to schedule the automations format: int64

example: [97, 100]

description (optional)

String Text describing the automation

example: Schedule automation to run email bot.

rdpEnabled (optional)

Boolean Indicates if remote desktop is enabled format: boolean

scheduleType (optional)

ScheduleType

dailyRecurrence (optional)

DailyRecurrence

timeZone (optional)

String Time zone where the schedule is set

example: Asia/Calcutta

startDate (optional)

example: 2022-11-16

endDate (optional)

example: 2022-12-16

startTime (optional)

example: 16:00

repeatEnabled (optional)

Boolean Run the schedule repeatedly format: boolean

repeatOccurrence (optional)

RepeatOccurrence

zonedNextRunDateTime (optional)

Date format: date-time

createdBy (optional)

String ID of the user who has created the automation

example: 97

createdOn (optional)

Date format: date-time

example: 2022-11-21T16:22:02.697Z

updatedBy (optional)

String ID of the user who has last updated the automation

example: 97

updatedOn (optional)

Date format: date-time

example: 2022-11-21T16:22:02.697Z

tenantId (optional)

Long Unique ID of the tenant format: int64

example: 1

fileName (optional)

String Name specified for the file

example: My bot_2

filePath (optional)

String Path where the file resides

example: Automation Anywhere\Bots\My bot_2

runAsUserIds (optional)

array[Long] Specify all the run as user IDs format: int64

example: [133, 170]

botInput (optional)

array[ScheduleAutomationResponse]

tenantUuid (optional)

String UUID of the tenant

example: 4090a32b-79c1-4fd8-b88s-b1ea8c994eb0

poolId (optional)

array[Long] The device pool IDs to schedule the automation format: int64

example: [9, 10]

overrideDefaultDevice (optional)

Boolean format: boolean

runElevated (optional)

Boolean format: boolean

automationPriority (optional)

AutomationPriority

botLabel (optional)

String Label specified for the bot.

example: Test Bot

`ScheduleFilterResponse` Up

page (optional)

PageResponse

list (optional)

`ScheduleType` Up

Specify the reoccurance interval to run the schedule

`Schema` Up

name (optional)

type (optional)

`Size2` Up

height (optional)

NestedNumberValue

width (optional)

NestedNumberValue

`Sort` Up

Sort directions

field (optional)

String Field name to sort by

example: name

direction (optional)

SortDirection

`SortDirection` Up

Sorting direction

`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[KeyValueItem]

expression (optional)

`TaskbotOutput` Up

type (optional)

map[String, UIObjectSelectionCriterion]

dictionary (optional)

array[KeyValueItem]

`TimeUnit` Up

`UIObject` Up

blob (optional)

String 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

`Value` Up

type (optional)

dictionary (optional)

array[Dictionary]

`WeekOfMonth` Up

`WeeklyRecurrence` Up

interval (optional)

Integer format: int32

daysOfWeek (optional)

array[DayOfWeek]

`Window` Up

name (optional)

nameRegex (optional)

RegexFileName

path (optional)

class (optional)

handle (optional)

Long format: int64

isChild (optional)

Boolean format: boolean

location (optional)

WindowLocation

size (optional)

WindowSize

presetType (optional)

WindowPreset

windowType (optional)

WindowWindowType

browserTabUrl (optional)

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

windowResize (optional)

Size2

`WindowWindowType` Up

`botinput` Up

iTestList (optional)

iTestList

`iTestList` Up

type (optional)

dictionary (optional)

array[Dictionary]

`protobufAny` Up

typeUrl (optional)

value (optional)

String format: byte

`runtimeError` Up

error (optional)

code (optional)

Integer format: int32

message (optional)