Automations

y (optional)

capture (optional)

PointImageCapture

`CredentialObject` Up

name (optional)

lockerName (optional)

attributeName (optional)

`DetailedError` Up

A detailed structure for error reporting, including localized message templates and parameters. This object provides a structured breakdown of the execution 'message' field for better parsing.

message (optional)

String A high-level, human-readable message, often indicating what caused the bot failure.

details (optional)

String Specific, technical details about the cause of the error, such as the exact reason for the bot failure.

correctiveAction (optional)

String Suggested steps the user can take to fix the error in future deployments.

code (optional)

String Bot failure Error code.

messageValues (optional)

array[String] A list of values used to populate variables in the message template (if applicable).

detailsValues (optional)

array[String] A list of values used to populate variables in the details template (if applicable).

correctiveActionValues (optional)

array[String] A list of values used to populate variables in the corrective action template (if applicable).

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

fileName (optional)

String Name of the automation that is deployed to execute

example: testbot

type (optional)

String Old Activity Type (deprecated in favor of activityType & initiationType) <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 - Automation export</li> <li>API - An automation that is run from an API</li> <li>AARI - A process bot</li> <li>RUN_NOW - A regular run as a users automation</li> <li>SCHEDULED - A scheduled automation</li> <li>TRIGGER - A triggered automation</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: 2025-10-21T18:26:11.175246Z

endDateTime (optional)

String Date and time when the execution ended

example: 2025-10-21T18:26:27.438843100Z

command (optional)

String Current command of the execution

example: messageBox

status (optional)

String Current status of the execution <li>COMPLETED - Automation successfully completed execution</li> <li>DEPLOYED - Autologin is successful, and automation is deployed to a device</li> <li>DEPLOY_FAILED - Automation 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 automation has not yet been deployed to that device</li> <li>RUNNING - Automation started execution</li> <li>UPDATE - Automation is in progress</li> <li>RUN_FAILED - Automation failed after being deployed to a device</li> <li>RUN_PAUSED - User paused the automation</li> <li>RUN_ABORTED - User aborted the automation</li> <li>RUN_TIMED_OUT - Automation 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

QUEUED

UPDATE

PENDING_EXECUTION

progress (optional)

Integer Current progress of the execution in percentage

example: 100

automationId (optional)

String Schedule id of the automation

example: 0

userId (optional)

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

example: 100000009

deviceId (optional)

String Device id where the automation is deployed

example: 1

currentLine (optional)

Integer Current line of automation that is deployed to execute

example: 1

totalLines (optional)

Integer Total lines of the automation that is deployed to execute

example: 1

fileId (optional)

String Id of the automation that is deployed to execute

example: 100000007

modifiedBy (optional)

String Id of the user who last updated the execution

example: 100000009

createdBy (optional)

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

example: 100000009

modifiedOn (optional)

String Date and time when the execution was last updated

example: 2025-10-22T04:18:56.826201Z

createdOn (optional)

String Date and time when the execution was created

example: 2025-10-22T04:18:52.422888Z

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)

Boolean A flag that shows whether or not the automation is using remote deployment protocol

message (optional)

String Error message that describes the state of the execution

example: There was a problem at line 1 This may be due to the following reason: Expected RecordValue with schema but missing, given: com.automationanywhere.botcommand.data.impl.RecordValue@4f10d90a To continue, edit the bot and fix the error. Then, try again. If you continue to see this message, please contact your system administrator.

canManage (optional)

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

deviceName (optional)

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

example: AAUS34NS3RM

userName (optional)

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

example: john_unattended

tenantUuid (optional)

String The UUID code of the tenant the automation 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 automation deployed using elevated permissions or not

example: false

botLabel (optional)

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

example: PRODUCTION

currentBotName (optional)

String The automation'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

rolesWithAccess (optional)

array[String] List of roles that have access to the execution.

example: []

workspaceType (optional)

String The type of workspace where the automation is stored.

Enum:

PRIVATE

PUBLIC

example: PRIVATE

parentId (optional)

String Only returned for child executions that are spawned by a parent execution. Will be the same as the parent execution's unique ID.

example: 8f1d7270-3ca7-4c51-b412-2c214c6550cf

initiationType (optional)

String Initiation type for the activity. <ul> <li>API - Activity initiated by API or backend.</li> <li>RUN_NOW - Activity initiated from Run Now option.</li> <li>SCHEDULED -Activity initiated from schedule.</li> <li>TRIGGER - Activity initiated by trigger.</li> <li>EXPORT - Activity initiated by an export of data.</li> <li>IMPORT - Activity initiated by an import of data.</li> <li>AARI - Activity initiated by Automation Anywhere Robotic Interface (AARI).</li> <li>WLM - Activity initiation by Workload Management (WLM).</li> <li>MIGRATION - Activity created by internal migration.</li> <li>CREATOR - Activity run from the bot creator editor page.</li> <li>DEBUG - Activity run from the debug mode of the bot creator editor page.</li> <li>RECORDER - Activity initiated by bot recorder.</li> </ul>

Enum:

API

RUN_NOW

SCHEDULED

TRIGGER

EXPORT

IMPORT

AARI

WLM

MIGRATION

CREATOR

DEBUG

RECORDER

example: API

activityType (optional)

String The type of activity. <ul> <li>BOT - Bot for robotic process automation.</li> <li>AUDIT_EXPORT - Export of a csv of Control Room audit logs.</li> <li>QUEUE_EXPORT - Export of a queue from workload management (WLM) in zip format.</li> <li>QUEUE_IMPORT - Import of a queue from workload management (WLM).</li> <li>WORKITEM_EXPORT - Export of a work item from workload management (WLM) in CSV format.</li> <li>ROLE_EXPORT - Export of assigned user and runasuser to a CSV file.</li> <li>BLM_EXPORT - Export of a single bot with its dependent files.</li> </ul>

Enum:

BOT

AUDIT_EXPORT

QUEUE_EXPORT

QUEUE_IMPORT

WORKITEM_EXPORT

BLM_EXPORT

ROLE_EXPORT

WORK_ORDER

PROCESS

FORM

APPROVAL

DOCUMENT_VALIDATION

TASK_PROCESS

TASK_APPROVAL

TASK_DOCUMENT_VALIDATION

TASK_BOT

TASK_API

API_TASK

example: BOT

deviceHostType (optional)

String Type of host where the device is running.

refId (optional)

String Reference id only for process related executions.

example: 4-0

error (optional)

DetailedError

userGroupName (optional)

String The user group name associated with the execution.

`ExecutionResponse` Up

page (optional)

PageResponse

list (optional)

array[Execution] list of automation 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)

array[JobExecutionStatusMetric]

modifierKeys (optional)

array[HotKeyModifierKey]

`HotKeyModifierKey` Up

`JobExecutionStatusMetric` Up

status (optional)

String The status of the activity

Enum:

UNKNOWN

DEPLOYED

RUNNING

RUN_PAUSED

UPDATE

COMPLETED

RUN_FAILED

RUN_ABORTED

RUN_TIMED_OUT

DEPLOY_FAILED

PENDING_EXECUTION

QUEUED

BOT_PRE_PROCESSING_SUCCESSFUL

BOT_PRE_PROCESSING_FAILED

example: DEPLOYED

count (optional)

Integer The number of times that the status occurred

example: 1

`JobExecutionStatusMetricsRequest` Up

timeRange (optional)

TimeRange

`JobExecutionStatusMetricsResponse` Up

metrics (optional)

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