Work Load Management (WLM) API

Use the Workload Management (WLM) API to programmatically manage and create work item models, queues, work items, and automations in your Control Room. To create a Workload Management automation process, ensure that you are allocated the following roles and permissions:

AAE_Pool Admin role and View all devices permission

AAE_Queue Admin role

Run bot permission

Run or schedule permission on the bots folder

Device pool consumer permission

Mapping of UI to API status for workload management work item processing:
UI - API
New - NEW
Ready to Run - READY_TO_RUN
Active - ACTIVE
Completed - COMPLETED
Failed - FAILED
On Hold - ON_HOLD
Data error - DATA_ERROR

All API calls must contain either an authentication token from Authentication API (generates JSON Web token) or a bearer token from OAuth services. You cannot use both together in an API.

Header: X-Authorization: <<authentication token>> or Authorization: Bearer <<bearer token>>

More information: https://helloreverb.com

Contact Info: hello@helloreverb.com

Version: 2.0.0

All rights reserved

http://apache.org/licenses/LICENSE-2.0.html

Access

APIKey KeyParamName:X-Authorization KeyInQuery:false KeyInHeader:true

Methods

Models

Table of Contents

Queues

Up

post /queues/{id}/consumers

Add queue consumer (queuesIdConsumersPost)

Use this API to add a role as a queue consumer to access the queues by specifying the queue ID.

Path parameters

id (required)

Path Parameter — ID of the queue format: int64

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body RoleId (required)

Body Parameter —

Return type

WlmRoles

Example data

Content-Type: application/json

{
  "roles" : [ {
    "name" : "admin",
    "id" : "456"
  }, {
    "name" : "admin",
    "id" : "456"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

201

Successful creation of queue consumer. WlmRoles

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

409

Conflict Error

500

Internal Server error Error

Up

get /queues/{id}

Get queue by ID (queuesIdGet)

Use this API to retrieve a specific queue by specifying the queue ID.

Path parameters

id (required)

Path Parameter — Returns queue by given ID format: int64

Return type

Queue

Example data

Content-Type: application/json

{
  "workItemProcessingOrders" : [ {
    "tenantUuid" : "4090a32b-79c1-4fd8-b88a-b1ea8c994cb0",
    "sortDirection" : "asc",
    "columnId" : "2",
    "name" : "Employee",
    "id" : "9",
    "priority" : "1"
  }, {
    "tenantUuid" : "4090a32b-79c1-4fd8-b88a-b1ea8c994cb0",
    "sortDirection" : "asc",
    "columnId" : "2",
    "name" : "Employee",
    "id" : "9",
    "priority" : "1"
  } ],
  "autoRetryLimit" : "1",
  "tenantUuid" : "4090a32b-79c1-4fd8-b88a-b1ea8c994cb0",
  "updatedBy" : "97",
  "displayColumnIds" : [ "16", "17", "18" ],
  "description" : "Calculate bonus for each employee",
  "updatedOn" : "2023-10-18T08:19:07.663681Z",
  "createdOn" : "2023-10-18T08:19:07.663681Z",
  "version" : "1",
  "disallowDuplicate" : true,
  "considerReactivationThreshold" : false,
  "reactivationThreshold" : "1",
  "manualProcessingTime" : "1",
  "createdBy" : "97",
  "name" : "Finance Queue",
  "manualProcessingTimeUnit" : "SECONDS",
  "tenantId" : "1",
  "workItemModelId" : "6",
  "id" : "9",
  "expiry" : "2023-10-18T08:19:07.663681Z",
  "status" : "DRAFT"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Returns queue details by given id Queue

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

404

Not found Error

500

Internal Server error Error

Up

put /queues/{id}/members/{userId}

Add or update a queue member (queuesIdMembersUserIdPut)

Use this API to add or update a queue member. Specify the queue ID and User ID to add or remove credentials to the queue or edit the queue settings.

Path parameters

id (required)

Path Parameter — ID of the queue format: int64

userId (required)

Path Parameter — ID of the user format: int64

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body body (required)

Body Parameter —

Return type

QueueMemberAdd

Example data

Content-Type: application/json

{
  "permissions" : [ "participate", "participate" ],
  "id" : "456"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

The queue member was successfully created or updated. QueueMemberAdd

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

409

Conflict Error

500

Internal Server error Error

Up

post /queues/{id}/participants

Add queue participant (queuesIdParticipantsPost)

Use this API to add a role as a queue participant by specifying the queue ID. The queue participants can add workItems to the queue.

Path parameters

id (required)

Path Parameter — ID of the queue format: int64

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body RoleId (required)

Body Parameter —

Return type

WlmRoles

Example data

Content-Type: application/json

{
  "roles" : [ {
    "name" : "admin",
    "id" : "456"
  }, {
    "name" : "admin",
    "id" : "456"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

201

Successful creation of queue participant. WlmRoles

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

409

Conflict Error

500

Internal Server error Error

WorkItemModels

Up

get /workitemmodels/{id}

Get specific work item model by ID (workitemmodelsIdGet)

Use this API to retrieve a specific work item model. You must specify the ID of the work item model.

Path parameters

id (required)

Path Parameter — model id format: int64

Return type

WorkItemModel

Example data

Content-Type: application/json

{
  "tenantUuid" : "4090a32b-79c1-4fd8-b88a-b1ea8c994cb0",
  "updatedBy" : "29",
  "createdBy" : "27",
  "name" : "Bonus Template",
  "tenantId" : "1",
  "attributes" : [ {
    "id" : "3"
  }, {
    "id" : "3"
  } ],
  "id" : "5",
  "updatedOn" : "2023-10-18T08:19:07.663681Z",
  "createdOn" : "2023-10-18T08:19:07.663681Z",
  "version" : "0"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Returns model for given id WorkItemModel

404

Not found Error

400

Bad Request Error

500

Internal Server error Error

Up

post /workitemmodels

Create a work item model (workitemmodelsPost)

Use this API to define a work item model for processing in a queue. Work item model is the structure of a work item, it defines all the fields along with their data types (string, numbers, and date etc).

Consumes

This API call consumes the following media types via the request header:

*/*

Request body

body WorkItemModelWithoutId (required)

Body Parameter —

Return type

WorkItemModel

Example data

Content-Type: application/json

{
  "tenantUuid" : "4090a32b-79c1-4fd8-b88a-b1ea8c994cb0",
  "updatedBy" : "29",
  "createdBy" : "27",
  "name" : "Bonus Template",
  "tenantId" : "1",
  "attributes" : [ {
    "id" : "3"
  }, {
    "id" : "3"
  } ],
  "id" : "5",
  "updatedOn" : "2023-10-18T08:19:07.663681Z",
  "createdOn" : "2023-10-18T08:19:07.663681Z",
  "version" : "0"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Return created work item model WorkItemModel

500

Internal Server error Error

Workitems

Up

post /queues/{id}/file

Create new work items from a file (queuesIdFilePost)

Use this API to create new work items in the queue. You must specify the queue ID and choose a work item CSV file.

Path parameters

id (required)

Path Parameter — Queue ID format: int64

Consumes

This API call consumes the following media types via the request header:

multipart/form-data

Form parameters

upload (required)

Form Parameter — format: binary

Return type

workOrder

Example data

Content-Type: application/json

{
  "connectionString" : "wlm-files\\1\\Qx7QDk8Z_MonJun03182147PDT2024_1717464107930;fetchRecords=0",
  "queueId" : "456",
  "tenantUuid" : "4090a32b-79c1-4fd8-b88a-b1ea8c994cb0",
  "totalRecords" : "100",
  "uploadedFileName" : "workitems.csv",
  "updatedBy" : "27",
  "filePath" : "\\AutomationAnywhere\\Server Files\\wlm-files",
  "updatedOn" : "2023-10-18T08:19:07.663681Z",
  "type" : "csv",
  "createdOn" : "2023-10-18T08:19:07.663681Z",
  "startIndex" : "0",
  "queueName" : "Finance Queue",
  "createdBy" : "27",
  "name" : "workorder.csv",
  "id" : "456",
  "executionStartedOn" : "2023-10-18T08:19:07.663681Z",
  "uniqueId" : "456",
  "status" : "draft"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Result workOrder

401

Authentication required Error

404

Not found Error

403

Unauthorized access Error

500

Internal Server error Error

Up

put /queues/{id}/workitems/{workItemId}

Update work item (queuesIdWorkitemsWorkItemIdPut)

Use this API to update work item data, result, and status.

Path parameters

id (required)

Path Parameter — Queue ID format: int64

workItemId (required)

Path Parameter — Work item ID format: int64

Consumes

This API call consumes the following media types via the request header:

*/*

Request body

body UpdateWorkItem (required)

Body Parameter — Work item object

Return type

UpdateWorkItemResponse

Example data

Content-Type: application/json

{
  "queueId" : "queueId",
  "automationId" : "automationId",
  "tenantUuid" : "4090a32b-79c1-4fd8-b88a-b1ea8c994cb0",
  "totalPausedTime" : "totalPausedTime",
  "deferredUntil" : "2023-10-18T08:19:07.663681Z",
  "error" : "null",
  "createdOn" : "2023-10-18T08:19:07.663681Z",
  "deviceId" : "deviceId",
  "lastPausedTime" : "2023-10-18T08:19:07.663681Z",
  "result" : "result",
  "col8" : "Kayle",
  "hashCode" : "-2081237442",
  "col9" : "Nicole",
  "col6" : "Kevin",
  "json" : {
    "Invoice Date" : "2023-01-10T00:18:48Z",
    "Amount" : "140",
    "Invoice Id" : "INV123",
    "Customer Name" : "Jane",
    "email" : "jane@automationanywhere.com"
  },
  "col7" : "Ryan",
  "startTime" : "2023-10-18T08:19:07.663681Z",
  "col4" : "John",
  "id" : "31250",
  "col5" : "Smith",
  "col2" : "Doe",
  "col3" : "45",
  "col1" : "Jane",
  "updatedBy" : "97",
  "jobExecutionId" : "null",
  "retryCount" : "retryCount",
  "updatedOn" : "2023-10-18T08:19:07.663681Z",
  "version" : "version",
  "createdBy" : "97",
  "col10" : "Katie",
  "deviceUserId" : "deviceUserId",
  "comment" : "Bonus workitems",
  "endTime" : "2023-11-20T08:19:07.663681Z",
  "status" : "UNKNOWN"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Updated work item UpdateWorkItemResponse

401

Authentication required Error

404

Not found Error

403

Unauthorized access Error

500

Internal Server error Error

Models

Methods

Table of Contents

Error
Queue
QueueMemberAdd
QueueMemberPermissions
RoleId
UpdateWorkItem
UpdateWorkItemResponse
WlmRole
WlmRoles
WorkItem
WorkItemJson
WorkItemModel
WorkItemModelAttribute
WorkItemModelAttributeWithoutId
WorkItemModelWithoutId
WorkItemProcessingOrder
body
body_1
workOrder

`Error` Up

code (optional)

Integer Error code

message (optional)

String Message describing error

`Queue` Up

id (optional)

String Unique identifier representing a specific queue. Represented as a string containing an int64 value.

example: 9

name (optional)

String Name of the queue

example: Finance Queue

description (optional)

String Description of the queue

example: Calculate bonus for each employee

reactivationThreshold (optional)

String Minimum number of workItems in the queue to reactivate queue. Represented as a string containing an int64 value.

example: 1

manualProcessingTime (optional)

String Efforts required to process the queue manually. Represented as a string containing an int64 value.

example: 1

manualProcessingTimeUnit (optional)

String Time duration to process the queue manually

Enum:

SECONDS

MINUTES

HOURS

DAYS

disallowDuplicate (optional)

Boolean Do not allow duplicate work item.

autoRetryLimit (optional)

String Enter a re-try limit to automatically retry the queue in case of a failure. Represented as a string containing an int64 value.

example: 1

status (optional)

String Status of the queue

Enum:

DRAFT

IN_USE

NOT_IN_USE

workItemModelId (optional)

String ID of the work item model. Represented as a string containing an int64 value.

example: 6

workItemProcessingOrders (optional)

array[WorkItemProcessingOrder]

displayColumnIds (optional)

array[String]

example: ["16","17","18"]

createdBy (optional)

String User ID who has created the queue. Represented as a string containing an int64 value.

example: 97

createdOn (optional)

String Time the queue was created in the ISO 8601 format.

example: 2023-10-18T08:19:07.663681Z

updatedBy (optional)

String User ID who last updated the queue. Represented as a string containing an int64 value.

example: 97

updatedOn (optional)

String Time the queue was last updated in the ISO 8601 format.

example: 2023-10-18T08:19:07.663681Z

tenantId (optional)

String Unique ID of the tenant. Represented as a string containing an int64 value.

example: 1

version (optional)

String Version of the queue. Represented as a string containing an int64 value.

example: 1

considerReactivationThreshold (optional)

Boolean This is an optional parameter. It is recommended to retain the default value.

example: false

tenantUuid (optional)

String The universally unique identifier (UUID) of the tenant. This UUID is used for accessing the tenant via the API.

example: 4090a32b-79c1-4fd8-b88a-b1ea8c994cb0

expiry (optional)

String Date when the work item model was created in the ISO 8601 format.

example: 2023-10-18T08:19:07.663681Z

`QueueMemberAdd` Up

id (optional)

String Unique identifier representing a specific role. Represented as a string containing an int64 value.

example: 456

permissions (optional)

QueueMemberPermissions

`QueueMemberPermissions` Up

Queue specific actions a given user is allowed to perform

`RoleId` Up

id (optional)

Long Unique identifier representing a specific role format: int64

example: 456

`UpdateWorkItem` Up

id (optional)

BigDecimal work item ID

example: 31242.0

queueId (optional)

BigDecimal queue ID

version (optional)

BigDecimal Hibernate maintained version of work item object

status (optional)

String

Enum:

READY_TO_RUN

DATA_ERROR

UNKNOWN

NEW

QUEUED

ACTIVE

FAILED

COMPLETED

ON_HOLD

result (optional)

String Status of the work item

json (optional)

WorkItemJson

`UpdateWorkItemResponse` Up

`WlmRole` Up

id (optional)

String Unique identifier representing a specific role. Represented as a string containing an int64 value.

example: 456

name (optional)

String Name of the role

example: admin

`WlmRoles` Up

roles (optional)

array[WlmRole]

`WorkItem` Up

id (optional)

String Unique identifier representing a specific workItem. Represented as a string containing an int64 value

example: 31250

createdBy (optional)

String User ID who has created the work items. Represented as a string containing an int64 value

example: 97

createdOn (optional)

String Time stamp when the workitem was created in the ISO 8601 format.

example: 2023-10-18T08:19:07.663681Z

updatedBy (optional)

String User ID who has last updated the work item. Represented as a string containing an int64 value

example: 97

updatedOn (optional)

String Time stamp when the workitem was updated in the ISO 8601 format.

example: 2023-10-18T08:19:07.663681Z

version (optional)

String Version of the workitem

json (optional)

WorkItemJson

result (optional)

String output of workItem's processing

deviceId (optional)

String Reference key with device entity. Represented as a string containing an int64 value

status (optional)

String

Enum:

UNKNOWN

ON_HOLD

FAILED

COMPLETED

DATA_ERROR

ACTIVE

STAGED

QUEUED

READY_TO_RUN

NEW

DRAFT

startTime (optional)

String Start time in ISO 8601 format

example: 2023-10-18T08:19:07.663681Z

endTime (optional)

String Start time in ISO 8601 format

example: 2023-11-20T08:19:07.663681Z

col1 (optional)

String First displayable column in workitem

example: Jane

col2 (optional)

String Second displayable column in workitem

example: Doe

col3 (optional)

String Third displayable column in workitem

example: 45

col4 (optional)

String Fourth displayable column in workitem

example: John

col5 (optional)

String Fifth displayable column in workitem

example: Smith

col6 (optional)

String Sixth displayable column in workitem

example: Kevin

col7 (optional)

String Seventh displayable column in workitem

example: Ryan

col8 (optional)

String Eighth displayable column in workitem

example: Kayle

col9 (optional)

String Nineth displayable column in workitem

example: Nicole

col10 (optional)

String Tenth displayable column in workitem

example: Katie

deviceUserId (optional)

String Runas user ID who has access to the device. Represented as a string containing an int64 value

queueId (optional)

String Reference key with queue entity. Represented as a string containing an int64 value

comment (optional)

String Comments added to the workitem

example: Bonus workitems

automationId (optional)

String Reference key with automation entity. Represented as a string containing an int64 value

lastPausedTime (optional)

String The last paused time in ISO 8601 format

example: 2023-10-18T08:19:07.663681Z

totalPausedTime (optional)

String Total pause time to process the workitems. Represented as a string containing an int64 value

error (optional)

String Error while processing workitem

jobExecutionId (optional)

String ID of the job successfully completed

deferredUntil (optional)

String Time in ISO 8601 format until the work item is deferred

example: 2023-10-18T08:19:07.663681Z

retryCount (optional)

String The total number of times this work item has been retried. Represented as a string containing an int64 value

hashCode (optional)

String Hash code of the workitem's contents. Represented as a string containing an int64 value

example: -2081237442

tenantUuid (optional)

String The universally unique identifier (UUID) of the tenant. This UUID is used for accessing the tenant via the API.

example: 4090a32b-79c1-4fd8-b88a-b1ea8c994cb0

`WorkItemJson` Up

WorkItem as JSON object. For the List endpoints the JSON value will be empty in the response. Examples provided for the JSON values are displayed for the other endpoints.

Customer Name (optional)

String

example: Jane

Invoice Id (optional)

String

example: INV123

Amount (optional)

String

example: 140

email (optional)

String

example: jane@automationanywhere.com

Invoice Date (optional)

String

example: 2023-01-10T00:18:48Z

`WorkItemModel` Up

id (optional)

String A unique identifier represented as a string containing an int64 value

example: 5

name (optional)

String Name of the work item model

example: Bonus Template

createdBy (optional)

String ID of the user who created the work item model. Represented as a string containing an int64 value

example: 27

createdOn (optional)

String Date when the work item model was created in the ISO 8601 format.

example: 2023-10-18T08:19:07.663681Z

updatedBy (optional)

String ID of the user who last updated the work item model. Represented as a string containing an int64 value

example: 29

updatedOn (optional)

String Date when the work item model was last updated in the ISO 8601 format.

example: 2023-10-18T08:19:07.663681Z

tenantId (optional)

String The unique identifier for the tenant that is associated with the work item model. Represented as a string containing an int64 value

example: 1

version (optional)

String The version assosicated with the work item model. Represented as a string containing an int64 value

example: 0

tenantUuid (optional)

String The universally unique identifier (UUID) of the tenant. This UUID is used for accessing the tenant via the API.

example: 4090a32b-79c1-4fd8-b88a-b1ea8c994cb0

attributes (optional)

array[WorkItemModelAttribute]

`WorkItemModelAttribute` Up

name (optional)

String name of the work item model

example: Employee Salary

type (optional)

String

Enum:

NUMBER

TEXT

DATE

id (optional)

String unique identifier of the value in the workitem model template. Represented as a string containing an int64 value.

example: 3

`WorkItemModelAttributeWithoutId` Up

name (optional)

String name of the work item model

example: Employee Salary

type (optional)

String

Enum:

NUMBER

TEXT

DATE

`WorkItemModelWithoutId` Up

name (optional)

String Name of the workitem model

example: Bonus Template

attributes (optional)

array[WorkItemModelAttributeWithoutId]

`WorkItemProcessingOrder` Up

columnId (optional)

String Represented as a string containing an int64 value.

example: 2

priority (optional)

String Represented as a string containing an int64 value.

example: 1

name (optional)

String

example: Employee

sortDirection (optional)

String

example: asc

tenantUuid (optional)

String The universally unique identifier (UUID) of the tenant. This UUID is used for accessing the tenant via the API.

example: 4090a32b-79c1-4fd8-b88a-b1ea8c994cb0

id (optional)

String Unique identifier representing a specific queue. Represented as a string containing an int64 value.

example: 9

`body` Up

permissions (optional)

QueueMemberPermissions

`body_1` Up

upload

byte[] CSV file format: binary

`workOrder` Up

id (optional)

String Unique identifier representing a specific role. Represented as a string containing an int64 value.

example: 456

name (optional)

String Name of the uploaded file that has work orders

example: workorder.csv

type (optional)

String Type of the source of the work items

Enum:

csv

excel

ftp

database

status (optional)

String Status of the work order

Enum:

draft

new

file_uploaded

in_progress

completed

failed

staged

finalizing

queueId (optional)

String Unique identifier representing a specific queue. Represented as a string containing an int64 value.

example: 456

queueName (optional)

String Name of the Queue

example: Finance Queue

filePath (optional)

String Path of the file where workitems file got uploaded.

example: \AutomationAnywhere\Server Files\wlm-files

uniqueId (optional)

String Unique identifier represented as a string containing an int64 value.

example: 456

uploadedFileName (optional)

String Source name of the file from where work items got loaded

example: workitems.csv

startIndex (optional)

String Start index for the workitems to chose from. Represented as a string containing an int64 value.

example: 0

connectionString (optional)

String Metdadata to fetch the records

example: wlm-files\1\Qx7QDk8Z_MonJun03182147PDT2024_1717464107930;fetchRecords=0

executionStartedOn (optional)

String Date when the execution got started in the ISO 8601 format.

example: 2023-10-18T08:19:07.663681Z

totalRecords (optional)

String Total number of workitems to be processed. Represented as a string containing an int64 value.

example: 100

createdBy (optional)

String ID of the user who created the work item model. Represented as a string containing an int64 value

example: 27

createdOn (optional)

String When the workorder got created in the ISO 8601 format.

example: 2023-10-18T08:19:07.663681Z

updatedBy (optional)

String ID of the user who last updated the work item model. Represented as a string containing an int64 value

example: 27

updatedOn (optional)

String When the workorder got updated in the ISO 8601 format.

example: 2023-10-18T08:19:07.663681Z

tenantUuid (optional)

String The universally unique identifier (UUID) of the tenant. This UUID is used for accessing the tenant via the API.

example: 4090a32b-79c1-4fd8-b88a-b1ea8c994cb0

Automation 360

Workload Management API (v4)