Process Composer API

example: STRING

string (optional)

example: value1

`CallbackInfo` Up

url (optional)

String Callback API URL.

example: https://callbackserver.com/storeBotExecutionStatus

headers (optional)

HeaderMap

`Coordinate` Up

x (optional)

y (optional)

capture (optional)

PointImageCapture

`CreateRequest` Up

processId (optional)

Integer Specify the process ID.

example: 4

processPath (optional)

String Specify the folder ID of the process. Process path is the repository path where the process file resides.

example: 4

repositoryReference (optional)

String Specify whether the repository where the process file resides is public or private.

Enum:

PUBLIC

PRIVATE

teamId (optional)

Integer Specify the AARI team ID.

example: 12

inputs (optional)

initiatorType (optional)

String Specify the process initiator as Bot or User.

Enum:

BOT

USER

callbackInfo (optional)

CallbackInfo

`CreateRequestResponse` Up

id (optional)

Integer ID of the request created

example: 5

ref (optional)

String Request reference ID for the created form.

example: 47-13

`CredentialObject` Up

name (optional)

lockerName (optional)

attributeName (optional)

`Dictionary` Up

`Dictprop` Up

key (optional)

example: key1

value (optional)

BotValue

`Error` Up

code (optional)

Integer Error code

message (optional)

String Message describing error

`FileIdentity` Up

id (optional)

Integer Unique ID of the file.

version (optional)

Integer Version number of the file.

`FormResponse` Up

id (optional)

Integer Unique ID of the form.

example: 50

title (optional)

String Form title.

example: AARI_Process

form (optional)

String Form attribute defintions.

example: "form":{"properties":{"title":"Form title","dimension":{"height":600,"width":450,"displayHeight":600},"font":{"fontType":"System","fontSize":"MEDIUM"},"closeOnEndMachine":false,"minimizeOnEndMachine":false,"hiddenElements":[],"brandLogos":[],"logoCount":"Zero"},"position":{"isFormPreviewCentered":false,"startX":650,"startY":10},"meta":{"version":"2.1"},"rows":[{"columns":[{"width":50},{"width":50}]}],"rules":[],"documentElement":{}}}

aaFileStorage (optional)

String Type of file storage

Enum:

aari

iqbot

values (optional)

dynamicFormSchema (optional)

`HeaderMap` Up

This is key value objects, collection of headers with key and value.

key (optional)

example: X-Authorization

value (optional)

example: eyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiI0Ii

`HotKey` Up

key (optional)

modifierKeys (optional)

array[HotKeyModifierKey]

`HotKeyModifierKey` Up

`KeyValueItem` Up

key (optional)

value (optional)

`NestedStringValue` Up

type (optional)

string (optional)

expression (optional)

`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

`ProcessInfoBasicDto` Up

id (optional)

Integer Process ID.

example: 4

title (optional)

String Process Title

example: aari_process

tags (optional)

array[String]

creationMode (optional)

array[String] Mode in which the process is created.

Enum:

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

`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

`RequestDto` Up

id (optional)

Integer Request ID

example: 2

title (optional)

String Title specified for the request

example: AARI process

info (optional)

String Details of information message

example: System Error: Default Scheduler configuration missing scheduler

process (optional)

inputs (optional)

outputs (optional)

steps (optional)

status (optional)

String Status of the request

Enum:

OPENED

SUCCESS

ERROR

CANCELLED

initiatorType (optional)

String Initiator of the request

Enum:

UNKNOWN

BOT

USER

createdOn (optional)

String Date the request was created

example: 2023-02-01T09:27:58.128875Z

updatedOn (optional)

String Date the request was last updated

example: 2023-02-01T09:27:58.292445Z

createdBy (optional)

Integer ID of the user who created the request

example: 160

initialStepTitle (optional)

String Initial Title

example: Request Created

initialStepInfo (optional)

hasHiddenSteps (optional)

Boolean

createdByTeamId (optional)

example: 2

workspaceType (optional)

Enum:

PUBLIC

PRIVATE

recoveredBy (optional)

example: 0

recoveredOn (optional)

example: 2023-02-01T09:27:58.292445Z

recycleSchedule (optional)

ref (optional)

example: 47-13

`Row` Up

values (optional)

array[Value]

`Schema` Up

name (optional)

type (optional)

`StepRecordDto` Up

id (optional)

example: 3

title (optional)

example: aari_process

formContent (optional)

inputs (optional)

outputs (optional)

controls (optional)

KeyValueItem

status (optional)

info (optional)

String Details of information message

example: System Error: Default Scheduler configuration missing scheduler

processStepUuid (optional)

type (optional)

Enum:

INIT

BOT

FORM

STREAM

PROCESS

IFRAME

API_BOT

stepState (optional)

Enum:

IN_PROGRESS

COMPLETED

createdOn (optional)

String Date the request was created

example: 2023-02-01T09:27:58.128875Z

updatedOn (optional)

String Date the request was last updated

example: 2023-02-01T09:27:58.128875Z

updatedBy (optional)

Integer ID of the user who updated the request.

example: 160

assigneeId (optional)

progressStatus (optional)

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

activityUniqueId (optional)

dynamicFormSchema (optional)

dynamicControls (optional)

nonExecStatus (optional)

Object

subType (optional)

Object

sourceUri (optional)

workspaceType (optional)

Enum:

PUBLIC

PRIVATE

assignmentSource (optional)

Enum:

UNKNOWN_ASSIGNMENT_SOURCE

UNASSIGNED

MANUAL_ASSIGN

AUTO_ASSIGN

AUTO_ASSIGN_ON_VIEW

assignmentRuleType (optional)

Enum:

NO_AUTO_ASSIGN_RULE

AUTO_ASSIGN_TO_CREATOR_RULE

AUTO_ASSIGN_TO_CREATOR_MANAGER_RULE

AUTO_ASSIGN_ON_VIEW_RULE

teamRequestVisibility (optional)

Enum:

PRIVATE

SHARED

stepSubState (optional)

Enum:

NO_SUB_STATE

HUMAN_PENDING

HUMAN_SUBMITTED

HUMAN_CANCELED

HUMAN_EXPIRED

BOT_INITIATED

BOT_QUEUED

BOT_RUNNING

BOT_FAILED

BOT_SUCCESS

PROCESS_OPEN

PROCESS_FINISH_CANCELED

PROCESS_FINISH_ERROR

PROCESS_FINISH_SUCCESS

PROCESS_NOT_CREATED

SYSTEM_EXPIRED

aaFileStorage (optional)

Enum:

aari

iqbot

expiresOn (optional)

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

`TaskbotOutput` Up

type (optional)

map[String, UIObjectSelectionCriterion]

dictionary (optional)

Dictionary

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

`Value1` Up

type (optional)

dictionary (optional)

`ValueMap` Up

type (optional)

dictionary (optional)

`ValueMap1` Up

This is key value objects, collection of value objects with key and value.

value (optional)

iTestList

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

`iTestList` Up

type (optional)

dictionary (optional)