Bot Execution Orchestrator API

y (optional)

capture (optional)

PointImageCapture

`CredentialObject` Up

name (optional)

lockerName (optional)

attributeName (optional)

`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

`Execution` Up

id (optional)

String Unique execution id

example: 972f41ee-90e7-4a62-8d1-055dc9c3b59c_668b1db6649c43da

automationName (optional)

String Name of the automation to which the execution is associated

example: testbot.2022.04.13.22.22.50.john_creator

fileName (optional)

String Name of the bot that is deployed to execute

example: testbot

type (optional)

String File type associated with the bot. <ul> <li>WORKORDER - Depicts the status of the workitems uploaded from the CSV file</li> <li>WLM_TASK - A Work load management bot</li> <li>EXPORT - Bot export</li> <li>API - A bot that is run from an API</li> <li>AARI - A process bot</li> <li>RUN_NOW - A regular run as a users bot</li> <li>SCHEDULED - A scheduled bot</li> <li>TRIGGER - A triggered bot</li> <li>AUDIT_EXPORT - Audit export</li> <li>QUEUE_EXPORT - Queue export</li> <li>QUEUE_IMPORT - Queue import</li> <li>WORKITEM_EXPORT - List of Workitem export in CSV</li></ul>

Enum:

WORKORDER

WLM_TASK

EXPORT

API

AARI

RUN_NOW

SCHEDULED

TRIGGER

AUDIT_EXPORT

QUEUE_EXPORT

QUEUE_IMPORT

WORKITEM_EXPORT

example: TRIGGER

startDateTime (optional)

String Date and time when the execution started

example: 2022-04-14T06:39:24.254386346Z

endDateTime (optional)

String Date and time when the execution ended

example: 2022-04-14T06:39:27.438843100Z

command (optional)

String Current command of the execution

example: messageBox

status (optional)

String Current status of the execution <li>COMPLETED - Bot successfully completed execution</li> <li>DEPLOYED - Autologin is successful, and bot is deployed to a device</li> <li>DEPLOY_FAILED - Bot failed to deploy to the device because, for example, autologin failed</li> <li>QUEUED - Requested user or device is busy running another execution</li> <li>PENDING_EXECUTION - Device has been selected, but bot has not yet been deployed to that device</li> <li>RUNNING or UPDATE - Bot is executing on a device</li> <li>RUN_FAILED - Bot failed after being deployed to a device</li> <li>RUN_PAUSED - User paused the bot</li> <li>RUN_TIMED_OUT - Bot failed to complete tasks within a specific time period</li> <li>UNKNOWN - Connection between the service and the device was lost</li> </ul>

Enum:

COMPLETED

DEPLOYED

RUNNING

RUN_PAUSED

UNKNOWN

RUN_FAILED

RUN_ABORTED

RUN_TIMED_OUT

DEPLOY_FAILED

progress (optional)

Integer Current progress of the execution in percentage

example: 100

automationId (optional)

String Schedule id of the automation

userId (optional)

String Corresponding User id of the device where the bot is deployed

example: 1

deviceId (optional)

String Device id where the bot is deployed

example: 1

currentLine (optional)

Integer Current line of bot that is deployed to execute

example: 1

totalLines (optional)

Integer Total lines of the bot that is deployed to execute

example: 1

fileId (optional)

String Id of the bot that is deployed to execute

example: 1

modifiedBy (optional)

String Id of the user who last updated the execution

example: john_creator

createdBy (optional)

String Id of the user who created the automation associated with the execution

example: john_creator

modifiedOn (optional)

String Date and time when the execution was last updated

example: 2022-04-14T06:35:24.773187700Z

createdOn (optional)

String Date and time when the execution was created

example: 2022-04-14T06:36:25.873480700Z

deploymentId (optional)

String Deployment id to which the execution is associated

example: 494562cb-7c24-41d2-ae0e-8b8c5084ae90

queueName (optional)

String Queue name (deprecated)

queueId (optional)

String Queue id (deprecated)

usingRdp (optional)

String A flag that shows whether or not the bot is using remote deployment protocol

Enum:

true

false

message (optional)

String Error message that describes the state of the execution

canManage (optional)

String A flag that shows if the current logged in user has rights to manage the execution

Enum:

true

false

deviceName (optional)

String The name of the device the bot is designated to run on

example: AAUS34NS3RM

userName (optional)

String The username of the user the bot is designated to run from

example: john_unattended

tenantUuid (optional)

String The UUID code of the tenant the bot is being run from

example: e135e92d-27dd-405e-bc52-b8fad270476f

automationPriority (optional)

String The automation priority used when it is in queue

Enum:

PRIORITY_LOW

PRIORITY_MEDIUM

PRIORITY_HIGH

runElevated (optional)

Boolean A flag showing whether the bot deployed using elevated permissions or not

example: false

botLabel (optional)

String Label for the bot. It can be used to distinguish bots from categories like production and testing

example: PRODUCTION

currentBotName (optional)

String The bot's current bot name. It can change during the execution

example: testbot

callbackInfo (optional)

String No value is returned for this parameter in the list API. Use the fetch execution API with specific id to retrieve that information

`ExecutionResponse` Up

page (optional)

PageResponse

list (optional)

array[Execution] list of bot executions.

`Filter` Up

Filter rules

operator (optional)

String Operator

Enum:

NONE

lt

le

eq

ne

ge

gt

substring

and

or

not

operands (optional)

array[Filter]

field (optional)

String Filter field could be either name,lastModified,path or directory.

value (optional)

String Filter value

`FilterRequest` Up

Filter request, which includes filtering, sorting and pagination rules

filter (optional)

Filter

sort (optional)

array[Sort] Sort directions

example: [{"field":"endDateTime","direction":"desc"}]

page (optional)

PageRequest

`HotKey` Up

key (optional)

modifierKeys (optional)

array[HotKeyModifierKey]

`HotKeyModifierKey` Up

`ManageActionError` Up

execution_id (optional)

String Execution ID of the job.

example: e5c8a404-0804-4448-ba89-56433db062c0

error_response (optional)

String Displays an error if the execution could not be stopped, paused, or resumed.

example: You do not have permission to view this execution or it is already terminated

`ManageExecutionsRequest` Up

Manage your execution requests by providing one or more execution IDs. You can stop, resume, or pause an execution one at a time and cannot perform these operations simultaneously.

stop_executions (optional)

StopExecutions

pause_executions (optional)

PauseExecutions

resume_executions (optional)

ResumeExecutions

`ManageExecutionsResponse` Up

requests_sent_to_device (optional)

array[String] Device ID to which the execution request is sent to. This object is an array and you can provide multiple device IDs.

example: ["d3c5d67e-cd45-4a50-9c7f-b2cefad9507c","3a19281a-5484-43c2-922e-e06be87f99d1","e5c8a404-0804-4448-ba89-56433db062c0"]

manage_action_errors (optional)

array[ManageActionError] Displays information if there is an error during execution.

`NestedStringValue` Up

type (optional)

string (optional)

expression (optional)

`PageRequest` Up

Pagination rules

offset (optional)

Integer Page starting index

length (optional)

Integer Page lengh

example: 1

`PageResponse` Up

Pagination response

offset (optional)

Integer Page starting index

example: 0

total (optional)

Integer Total number of items

example: 2

totalFilter (optional)

Integer Total number of items matching filter

example: 1

`PauseExecutions` Up

Pause an execution by providing the execution ID. This object is an array and you can provide multiple execution IDs.

execution_ids (optional)

array[String]

example: ["e5c8a404-0804-4448-ba89-56433db062c0","3a19281a-5484-43c2-922e-e06be87f99d1","e5c8a404-0804-4448-ba89-56433db062c0"]

`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

`ResumeExecutions` Up

Resume an execution by providing the execution ID. This object is an array and you can provide multiple execution IDs.

execution_ids (optional)

array[String]

example: ["e5c8a404-0804-4448-ba89-56433db062c0","3a19281a-5484-43c2-922e-e06be87f99d1","e5c8a404-0804-4448-ba89-56433db062c0"]

`Row` Up

values (optional)

array[Value]

`Schema` Up

name (optional)

type (optional)

`Sort` Up

Sorting rules

field (optional)

String Field name to sort by

direction (optional)

String Sorting direction

Enum:

asc

desc

`StopExecutions` Up

Stop an execution by providing the execution ID. This object is an array and you can provide multiple execution IDs.

execution_ids (optional)

array[String]

example: ["e5c8a404-0804-4448-ba89-56433db062c0","3a19281a-5484-43c2-922e-e06be87f99d1","e5c8a404-0804-4448-ba89-56433db062c0"]

`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

`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

list (optional)

array[Value]

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

`ValueMap` Up

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