Automation Scheduler API

example: STRING

string (optional)

example: value1

`CallbackInfo` Up

<p>callbackInfo provides the callback API URL and authentication token for the callback server. The API parameters such as device ID, user ID, deployment ID, status of the bot, and bot output details are captured as a payload in the callback server. <p>After the bot is deployed, the Control Room sends the deployment status and output variable values to this callback server. For example, to test the callback, you can create an account in https://pipedream.com/ and use the endpoint (similar to https://eogp1yk2w1o3ec2.m.pipedream.net) to receive the status and the output variable values.</p> <p><b>Note:</b> The callback server must accept POST calls to receive the bot execution data and the deployment status from the Control Room. </p></p>

url

String Callback API URL.

headers (optional)

map[String, String]

`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

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

UnattendedRequest (optional)

UnattendedRequest

`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

`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

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

`ScheduleAutomationChangeOwnerRequest` Up

scheduleIds

array[Long] Specify all schedule activity ids for which owner need to be change format: int64

example: [133, 170]

userId

Long Unique user Id for new owner format: int64

taskType (optional)

TaskType

`ScheduleAutomationListResponse` Up

id (optional)

Integer ID of automation schedule activity

activityName (optional)

taskType (optional)

TaskType

activityPriority (optional)

AutomationPriority

scheduleType (optional)

ScheduleType

dailyRecurrence (optional)

DailyRecurrence

weeklyRecurrence (optional)

WeeklyRecurrence

monthlyDateRecurrence (optional)

MonthlyDateRecurrence

monthlyWeekDayRecurrence (optional)

MonthlyWeekDayRecurrence

timeZone (optional)

startDate (optional)

endDate (optional)

startTime (optional)

repeatEnabled (optional)

ScheduleDeploymentResponse

zonedNextRunDateTime (optional)

Date format: date-time

fileId (optional)

Integer

fileName (optional)

String name of automation

runAsUserIds (optional)

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

example: [133, 170]

teamIdentifierType (optional)

String Process Identifier Type TEAM_ID/ROLE_ID/USER_ID

teamIdentifierId (optional)

Long Unique ID of Process Identifier TEAM_ID/ROLE_ID/USER_ID format: int64

status (optional)

AutomationStatus

ownedBy (optional)

Long owner of schedule, initially it is creator of schedule and will be same unless changes format: int64

createdBy (optional)

Long format: int64

createdOn (optional)

Date format: date-time

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

updatedBy (optional)

Long format: int64

updatedOn (optional)

Date format: date-time

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

`ScheduleAutomationRequest` Up

schedule (optional)

SchedulerRequest

deployment (optional)

DeploymentRequest

`ScheduleAutomationResponse` Up

id (optional)

Long Unique ID of the automation format: int64

example: 3

schedulerResponse (optional)

SchedulerResponse

taskType (optional)

TaskType

scheduleDeploymentResponse (optional)

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

`ScheduleDeploymentResponse` Up

activityName (optional)

String Name of schedule activity

description (optional)

String description of automation schedule activity

fileId (optional)

String automation id against which automation schedule created

fileName (optional)

String automation name against which automation schedule created

filePath (optional)

String automation path against which automation schedule created

fileLabel (optional)

fileInput (optional)

BotInput

runElevated (optional)

hideBotAgentUi (optional)

callbackInfo (optional)

CallbackInfo

activityPriority (optional)

AutomationPriority

handleUnexpectedPopups (optional)

array[ScheduleAutomationListResponse]

UnattendedRequest (optional)

UnattendedRequest

`ScheduleFilterResponse` Up

page (optional)

PageResponse

list (optional)

`ScheduleResiliency` Up

common (optional)

Object

recording (optional)

Object

`ScheduleType` Up

Specify the reoccurrence interval to run the schedule

`SchedulerRequest` Up

status (optional)

AutomationStatus

description (optional)

String Text describing the automation

example: Schedule automation to run email bot.

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

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.

ownedBy (optional)

Integer owner of schedule by default the creator of schedule is owner of schedule.

scheduleResiliency (optional)

ScheduleResiliency

`SchedulerResponse` Up

status (optional)

AutomationStatus

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

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.

ownedBy (optional)

Integer owner of schedule by default the creator of schedule is owner of schedule.

scheduleResiliency (optional)

ScheduleResiliency

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

`TaskType` Up

Specify the scheduled task type

`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

`UnattendedRequest` Up

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

unattendedRequest (optional)

unattendedRequestObj

`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

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

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

dictionary (optional)

array[Dictionary]

`protobufAny` Up

typeUrl (optional)

value (optional)

String format: byte

`runtimeError` Up

error (optional)

code (optional)

Integer format: int32

message (optional)