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

Automations

Up

delete /automations/{id}

Delete automation (automationsIdDelete)

Use this API to delete an automation by specifying the ID.

Path parameters

id (required)

Path Parameter — Unique ID of the automation format: int64

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

204

Returns NO_CONTENTS

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

404

Not found Error

500

Internal Server error Error

Up

get /automations/{id}

Get specific automation (automationsIdGet)

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

Path parameters

id (required)

Path Parameter — Unique ID of the automation format: int64

Return type

Automation

Example data

Content-Type: application/json

{
  "queueId" : 12.0,
  "hideBotAgentUi" : true,
  "tenantUuid" : "c0c31e64-f0ec-3754-424d-50422be0d52b",
  "description" : "Automation to calculate finances",
  "handleUnexpectedPopups" : false,
  "createdOn" : "2025-07-18T08:19:07.663681Z",
  "schedules" : {
    "intervals" : [ {
      "tenantUuid" : "c0c31e64-f0ec-3754-424d-50422be0d52b",
      "startTime" : "22:15:00",
      "id" : 1.0,
      "endTime" : "22:30:00",
      "ordinal" : 1.0
    }, {
      "tenantUuid" : "c0c31e64-f0ec-3754-424d-50422be0d52b",
      "startTime" : "22:15:00",
      "id" : 1.0,
      "endTime" : "22:30:00",
      "ordinal" : 1.0
    } ],
    "id" : 12.0,
    "daysOfWeek" : [ "MONDAY", "MONDAY" ],
    "ordinal" : 1.0
  },
  "rdpEnabled" : true,
  "zoneId" : "America/Los_Angeles",
  "id" : 10.0,
  "startedOn" : "2025-07-18T06:19:07.663681Z",
  "owner" : 1.0,
  "updatedBy" : 97.0,
  "startedBy" : 97.0,
  "resiliency" : {
    "common" : {
      "recording" : {
        "botStatus" : "FAILED",
        "enabled" : true
      },
      "handleUnexpectedPopups" : true,
      "detectAndNotify" : {
        "hideSensitiveInformation" : true,
        "enabled" : true
      }
    }
  },
  "updatedOn" : "2025-07-25T06:20:04.163681Z",
  "priority" : 1.0,
  "version" : 0.0,
  "averageProcessingTime" : 0.8008281904610115,
  "botVersion" : 0.0,
  "defaultDevices" : true,
  "createdBy" : 97.0,
  "tenantId" : 1.0,
  "name" : "Finance Automation",
  "botLabel" : "Bot",
  "poolId" : 12.0,
  "runAsUserIds" : "97, 101",
  "workItemsProcessed" : 4.0,
  "runElevated" : true,
  "totalPausedTimeInSec" : 60.0,
  "status" : "ACTIVE",
  "fileId" : 0.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 automation details by given ID Automation

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

404

Not found Error

500

Internal Server error Error

Up

put /automations/{id}

Update automation (automationsIdPut)

Use this API to update details of a specific automation by specifying the ID.

Path parameters

id (required)

Path Parameter — Unique ID of the automation format: int64

Consumes

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

*/*

Request body

body Automation (required)

Body Parameter —

Return type

Automation

Example data

Content-Type: application/json

{
  "queueId" : 12.0,
  "hideBotAgentUi" : true,
  "tenantUuid" : "c0c31e64-f0ec-3754-424d-50422be0d52b",
  "description" : "Automation to calculate finances",
  "handleUnexpectedPopups" : false,
  "createdOn" : "2025-07-18T08:19:07.663681Z",
  "schedules" : {
    "intervals" : [ {
      "tenantUuid" : "c0c31e64-f0ec-3754-424d-50422be0d52b",
      "startTime" : "22:15:00",
      "id" : 1.0,
      "endTime" : "22:30:00",
      "ordinal" : 1.0
    }, {
      "tenantUuid" : "c0c31e64-f0ec-3754-424d-50422be0d52b",
      "startTime" : "22:15:00",
      "id" : 1.0,
      "endTime" : "22:30:00",
      "ordinal" : 1.0
    } ],
    "id" : 12.0,
    "daysOfWeek" : [ "MONDAY", "MONDAY" ],
    "ordinal" : 1.0
  },
  "rdpEnabled" : true,
  "zoneId" : "America/Los_Angeles",
  "id" : 10.0,
  "startedOn" : "2025-07-18T06:19:07.663681Z",
  "owner" : 1.0,
  "updatedBy" : 97.0,
  "startedBy" : 97.0,
  "resiliency" : {
    "common" : {
      "recording" : {
        "botStatus" : "FAILED",
        "enabled" : true
      },
      "handleUnexpectedPopups" : true,
      "detectAndNotify" : {
        "hideSensitiveInformation" : true,
        "enabled" : true
      }
    }
  },
  "updatedOn" : "2025-07-25T06:20:04.163681Z",
  "priority" : 1.0,
  "version" : 0.0,
  "averageProcessingTime" : 0.8008281904610115,
  "botVersion" : 0.0,
  "defaultDevices" : true,
  "createdBy" : 97.0,
  "tenantId" : 1.0,
  "name" : "Finance Automation",
  "botLabel" : "Bot",
  "poolId" : 12.0,
  "runAsUserIds" : "97, 101",
  "workItemsProcessed" : 4.0,
  "runElevated" : true,
  "totalPausedTimeInSec" : 60.0,
  "status" : "ACTIVE",
  "fileId" : 0.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

Updates automation by given id Automation

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

404

Not found Error

500

Internal Server error Error

Up

post /automations/list

List of automations (automationsListPost)

Use this API to retrieve a list of all automations by using a specific queue.

Consumes

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

*/*

Request body

body FilterRequest (required)

Body Parameter —

Return type

array[Automation]

Example data

Content-Type: application/json

[ {
  "queueId" : 12.0,
  "hideBotAgentUi" : true,
  "tenantUuid" : "c0c31e64-f0ec-3754-424d-50422be0d52b",
  "description" : "Automation to calculate finances",
  "handleUnexpectedPopups" : false,
  "createdOn" : "2025-07-18T08:19:07.663681Z",
  "schedules" : {
    "intervals" : [ {
      "tenantUuid" : "c0c31e64-f0ec-3754-424d-50422be0d52b",
      "startTime" : "22:15:00",
      "id" : 1.0,
      "endTime" : "22:30:00",
      "ordinal" : 1.0
    }, {
      "tenantUuid" : "c0c31e64-f0ec-3754-424d-50422be0d52b",
      "startTime" : "22:15:00",
      "id" : 1.0,
      "endTime" : "22:30:00",
      "ordinal" : 1.0
    } ],
    "id" : 12.0,
    "daysOfWeek" : [ "MONDAY", "MONDAY" ],
    "ordinal" : 1.0
  },
  "rdpEnabled" : true,
  "zoneId" : "America/Los_Angeles",
  "id" : 10.0,
  "startedOn" : "2025-07-18T06:19:07.663681Z",
  "owner" : 1.0,
  "updatedBy" : 97.0,
  "startedBy" : 97.0,
  "resiliency" : {
    "common" : {
      "recording" : {
        "botStatus" : "FAILED",
        "enabled" : true
      },
      "handleUnexpectedPopups" : true,
      "detectAndNotify" : {
        "hideSensitiveInformation" : true,
        "enabled" : true
      }
    }
  },
  "updatedOn" : "2025-07-25T06:20:04.163681Z",
  "priority" : 1.0,
  "version" : 0.0,
  "averageProcessingTime" : 0.8008281904610115,
  "botVersion" : 0.0,
  "defaultDevices" : true,
  "createdBy" : 97.0,
  "tenantId" : 1.0,
  "name" : "Finance Automation",
  "botLabel" : "Bot",
  "poolId" : 12.0,
  "runAsUserIds" : "97, 101",
  "workItemsProcessed" : 4.0,
  "runElevated" : true,
  "totalPausedTimeInSec" : 60.0,
  "status" : "ACTIVE",
  "fileId" : 0.0
}, {
  "queueId" : 12.0,
  "hideBotAgentUi" : true,
  "tenantUuid" : "c0c31e64-f0ec-3754-424d-50422be0d52b",
  "description" : "Automation to calculate finances",
  "handleUnexpectedPopups" : false,
  "createdOn" : "2025-07-18T08:19:07.663681Z",
  "schedules" : {
    "intervals" : [ {
      "tenantUuid" : "c0c31e64-f0ec-3754-424d-50422be0d52b",
      "startTime" : "22:15:00",
      "id" : 1.0,
      "endTime" : "22:30:00",
      "ordinal" : 1.0
    }, {
      "tenantUuid" : "c0c31e64-f0ec-3754-424d-50422be0d52b",
      "startTime" : "22:15:00",
      "id" : 1.0,
      "endTime" : "22:30:00",
      "ordinal" : 1.0
    } ],
    "id" : 12.0,
    "daysOfWeek" : [ "MONDAY", "MONDAY" ],
    "ordinal" : 1.0
  },
  "rdpEnabled" : true,
  "zoneId" : "America/Los_Angeles",
  "id" : 10.0,
  "startedOn" : "2025-07-18T06:19:07.663681Z",
  "owner" : 1.0,
  "updatedBy" : 97.0,
  "startedBy" : 97.0,
  "resiliency" : {
    "common" : {
      "recording" : {
        "botStatus" : "FAILED",
        "enabled" : true
      },
      "handleUnexpectedPopups" : true,
      "detectAndNotify" : {
        "hideSensitiveInformation" : true,
        "enabled" : true
      }
    }
  },
  "updatedOn" : "2025-07-25T06:20:04.163681Z",
  "priority" : 1.0,
  "version" : 0.0,
  "averageProcessingTime" : 0.8008281904610115,
  "botVersion" : 0.0,
  "defaultDevices" : true,
  "createdBy" : 97.0,
  "tenantId" : 1.0,
  "name" : "Finance Automation",
  "botLabel" : "Bot",
  "poolId" : 12.0,
  "runAsUserIds" : "97, 101",
  "workItemsProcessed" : 4.0,
  "runElevated" : true,
  "totalPausedTimeInSec" : 60.0,
  "status" : "ACTIVE",
  "fileId" : 0.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

An array of automations

401

Authentication required Error

403

Unauthorized access Error

500

Internal Server error Error

Up

post /automations

Create automation (automationsPost)

Use this API to create an automation by specifying the queue ID. Automation is a combination of queue, bot, device pool, and runas users.

Consumes

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

application/json

Request body

body CreateAutomation (required)

Body Parameter —

Return type

array[Automation]

Example data

Content-Type: application/json

[ {
  "queueId" : 12.0,
  "hideBotAgentUi" : true,
  "tenantUuid" : "c0c31e64-f0ec-3754-424d-50422be0d52b",
  "description" : "Automation to calculate finances",
  "handleUnexpectedPopups" : false,
  "createdOn" : "2025-07-18T08:19:07.663681Z",
  "schedules" : {
    "intervals" : [ {
      "tenantUuid" : "c0c31e64-f0ec-3754-424d-50422be0d52b",
      "startTime" : "22:15:00",
      "id" : 1.0,
      "endTime" : "22:30:00",
      "ordinal" : 1.0
    }, {
      "tenantUuid" : "c0c31e64-f0ec-3754-424d-50422be0d52b",
      "startTime" : "22:15:00",
      "id" : 1.0,
      "endTime" : "22:30:00",
      "ordinal" : 1.0
    } ],
    "id" : 12.0,
    "daysOfWeek" : [ "MONDAY", "MONDAY" ],
    "ordinal" : 1.0
  },
  "rdpEnabled" : true,
  "zoneId" : "America/Los_Angeles",
  "id" : 10.0,
  "startedOn" : "2025-07-18T06:19:07.663681Z",
  "owner" : 1.0,
  "updatedBy" : 97.0,
  "startedBy" : 97.0,
  "resiliency" : {
    "common" : {
      "recording" : {
        "botStatus" : "FAILED",
        "enabled" : true
      },
      "handleUnexpectedPopups" : true,
      "detectAndNotify" : {
        "hideSensitiveInformation" : true,
        "enabled" : true
      }
    }
  },
  "updatedOn" : "2025-07-25T06:20:04.163681Z",
  "priority" : 1.0,
  "version" : 0.0,
  "averageProcessingTime" : 0.8008281904610115,
  "botVersion" : 0.0,
  "defaultDevices" : true,
  "createdBy" : 97.0,
  "tenantId" : 1.0,
  "name" : "Finance Automation",
  "botLabel" : "Bot",
  "poolId" : 12.0,
  "runAsUserIds" : "97, 101",
  "workItemsProcessed" : 4.0,
  "runElevated" : true,
  "totalPausedTimeInSec" : 60.0,
  "status" : "ACTIVE",
  "fileId" : 0.0
}, {
  "queueId" : 12.0,
  "hideBotAgentUi" : true,
  "tenantUuid" : "c0c31e64-f0ec-3754-424d-50422be0d52b",
  "description" : "Automation to calculate finances",
  "handleUnexpectedPopups" : false,
  "createdOn" : "2025-07-18T08:19:07.663681Z",
  "schedules" : {
    "intervals" : [ {
      "tenantUuid" : "c0c31e64-f0ec-3754-424d-50422be0d52b",
      "startTime" : "22:15:00",
      "id" : 1.0,
      "endTime" : "22:30:00",
      "ordinal" : 1.0
    }, {
      "tenantUuid" : "c0c31e64-f0ec-3754-424d-50422be0d52b",
      "startTime" : "22:15:00",
      "id" : 1.0,
      "endTime" : "22:30:00",
      "ordinal" : 1.0
    } ],
    "id" : 12.0,
    "daysOfWeek" : [ "MONDAY", "MONDAY" ],
    "ordinal" : 1.0
  },
  "rdpEnabled" : true,
  "zoneId" : "America/Los_Angeles",
  "id" : 10.0,
  "startedOn" : "2025-07-18T06:19:07.663681Z",
  "owner" : 1.0,
  "updatedBy" : 97.0,
  "startedBy" : 97.0,
  "resiliency" : {
    "common" : {
      "recording" : {
        "botStatus" : "FAILED",
        "enabled" : true
      },
      "handleUnexpectedPopups" : true,
      "detectAndNotify" : {
        "hideSensitiveInformation" : true,
        "enabled" : true
      }
    }
  },
  "updatedOn" : "2025-07-25T06:20:04.163681Z",
  "priority" : 1.0,
  "version" : 0.0,
  "averageProcessingTime" : 0.8008281904610115,
  "botVersion" : 0.0,
  "defaultDevices" : true,
  "createdBy" : 97.0,
  "tenantId" : 1.0,
  "name" : "Finance Automation",
  "botLabel" : "Bot",
  "poolId" : 12.0,
  "runAsUserIds" : "97, 101",
  "workItemsProcessed" : 4.0,
  "runElevated" : true,
  "totalPausedTimeInSec" : 60.0,
  "status" : "ACTIVE",
  "fileId" : 0.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

Newly created automation

401

Authentication required Error

403

Unauthorized access Error

500

Internal Server error Error

Queues

Up

post /queues/delete

Delete multiple queues (queuesDeletePost)

Use this API to delete multiple queues.You must specify the ID of the queues in an array.

Consumes

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

application/json

Request body

body integer (required)

Body Parameter —

Return type

String

Example data

Content-Type: application/json

"OK"

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

204

Return 'nocontent' String

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

500

Internal Server error Error

Up

get /queues/export/download/{downloadFileId}

Download exported queues (queuesExportDownloadDownloadFileIdGet)

Use this API to download the exported queues by specifying the file ID.

Path parameters

downloadFileId (required)

Path Parameter — Use the Download file ID from the status API

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/zip

Responses

200

OK

400

Bad Request Error

500

Internal Server error Error

Up

get /queues/export/download/status/{requestId}

Get Import/Export status by request ID (queuesExportDownloadStatusRequestIdGet)

Use this API to retrieve import or export status by specifying a request ID.

Path parameters

requestId (required)

Path Parameter — Specify the request ID

Return type

StatusResponse

Example data

Content-Type: application/json

{
  "downloadFileName" : "/crdata/Server Files/wlm-files/workitems/4090a32b-79c1-4fd8-b88a-b1ea8c994cb0/72b676eb-2801-47cb-91ea-5f71f06df0ba/cr-work-items-20250714-095032.csv",
  "requestId" : "50421ecb-9ce0-46e6-99ed-85ab623b5420",
  "errorMessage" : "null",
  "type" : "WORKITEM_EXPORT",
  "downloadFileId" : "72b676eb-2801-47cb-91ea-5f71f06df0ba",
  "status" : "IN_PROGRESS"
}

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

Status of import or export queue retrieved successfully. StatusResponse

400

Bad Request Error

500

Internal Server error Error

Up

post /queues/export

Export queues to archive file (queuesExportPost)

Use this API to export queues to compressed file.

Consumes

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

application/json

Request body

body ExportQueueRequest (required)

Body Parameter —

Return type

ExportQueueResponse

Example data

Content-Type: application/json

{
  "requestId" : "19bea097-afab-467f-bd25-1270e4c6f716"
}

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

202

Accepted ExportQueueResponse

400

Bad Request Error

500

Internal Server error Error

Up

get /queues/{id}/consumers

Get queue consumers (queuesIdConsumersGet)

Use this API to retrieve roles that have access to view this queue and all the work items in the queue. You must specify the queue ID.

Path parameters

id (required)

Path Parameter — ID of the queue

Return type

array[Role]

Example data

Content-Type: application/json

[ {
  "name" : "bot_manager",
  "id" : 456.0
}, {
  "name" : "bot_manager",
  "id" : 456.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

An array of user roles.

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

404

Not found Error

500

Internal Server error Error

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

Consumes

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

application/json

Request body

body RoleId (required)

Body Parameter —

Return type

QueueConsumers

Example data

Content-Type: application/json

{
  "tenantUuid" : "4090a32b-79c1-4fd8-b88a-b1ea8c994cb0",
  "updatedBy" : 97.0,
  "description" : "Finance queue to calculate bonus.",
  "countPrincipals" : 0.0,
  "principals" : [ 0, 0 ],
  "updatedOn" : "2025-07-25T06:20:04.163681Z",
  "createdOn" : "2025-07-18T08:19:07.663681Z",
  "version" : "0",
  "createdBy" : "97",
  "systemRole" : true,
  "permissions" : [ "participate", "participate" ],
  "tenantId" : "5",
  "name" : "Finanace Queue",
  "id" : 440.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

201

Successful creation of queue consumer. QueueConsumers

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

409

Conflict Error

500

Internal Server error Error

Up

delete /queues/{id}/consumers/{roleId}

Remove queue consumer (queuesIdConsumersRoleIdDelete)

Use this API to remove a queue consumer so that they cannot use the queues. You must specify the queue ID and the role ID to remove the queue consumer.

Path parameters

id (required)

Path Parameter — ID of the queue

roleId (required)

Path Parameter — ID of the role

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

204

The queue consumer is removed successfully.

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

404

Not found Error

500

Internal Server error Error

Up

delete /queues/{id}

Delete a queue by ID (queuesIdDelete)

Use this API to delete a queue by specifying the queue ID.

Path parameters

id (required)

Path Parameter — Specify the queue ID format: int64

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

204

no content available

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

404

Not found 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" : [ {
    "sortDirection" : "asc",
    "columnId" : 2,
    "priority" : 1
  }, {
    "sortDirection" : "asc",
    "columnId" : 2,
    "priority" : 1
  } ],
  "autoRetryLimit" : 6,
  "updatedBy" : 97,
  "displayColumnIds" : [ "16", "17", "18" ],
  "description" : "Calculate bonus for each employee",
  "updatedOn" : "2025-07-25T06:20:04.163681Z",
  "markDuplicate" : true,
  "createdOn" : "2025-07-18T08:19:07.663681Z",
  "version" : 5,
  "disallowDuplicate" : true,
  "considerReactivationThreshold" : true,
  "reactivationThreshold" : 1,
  "manualProcessingTime" : 0,
  "createdBy" : 97,
  "name" : "Finance Queue",
  "manualProcessingTimeUnit" : "SECONDS",
  "tenantId" : 1,
  "workItemModelId" : 6,
  "id" : 9.0,
  "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

get /queues/{id}/members

Get queue owner (queuesIdMembersGet)

Use this API to retrieve all users who can add or remove credentials to the queue or edit the queue settings. You must specify the queue ID.

Path parameters

id (required)

Path Parameter — ID of the queue

Return type

QueueMember

Example data

Content-Type: application/json

{
  "users" : [ 0, 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

An array of queue owners. QueueMember

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

404

Not found Error

500

Internal Server error Error

Up

delete /queues/{id}/members/{userId}

Remove queue member (queuesIdMembersUserIdDelete)

Use this API to remove users so that they cannot add or remove credentials to the queue or edit the queue settings. Specify the queue ID and User ID to remove a queue member.

Path parameters

id (required)

Path Parameter — ID of the queue

userId (required)

Path Parameter — ID of the user

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

204

Successful removal of queue member.

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

userId (required)

Path Parameter — ID of the user

Consumes

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

application/json

Request body

body body_1 (required)

Body Parameter —

Return type

QueueMemberAdd

Example data

Content-Type: application/json

{
  "permissions" : [ "participate", "participate" ],
  "id" : 456.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

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

get /queues/{id}/participants

Get queue participants (queuesIdParticipantsGet)

Use this API to retrieve all roles that can add workItems to the queue by specifying the queue ID.

Path parameters

id (required)

Path Parameter — ID of the queue

Return type

array[Role]

Example data

Content-Type: application/json

[ {
  "name" : "bot_manager",
  "id" : 456.0
}, {
  "name" : "bot_manager",
  "id" : 456.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

An array of user roles.

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

404

Not found 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

Consumes

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

application/json

Request body

body RoleId (required)

Body Parameter —

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.

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

409

Conflict Error

500

Internal Server error Error

Up

delete /queues/{id}/participants/{roleId}

Remove queue participant (queuesIdParticipantsRoleIdDelete)

Use this API to remove a queue participant so that they cannot add workItems in the queue. You must specify the queue ID and role ID to remove the queue participant.

Path parameters

id (required)

Path Parameter — ID of the queue

roleId (required)

Path Parameter — ID of the role

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

204

The queue participant is removed successfully.

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}

Update queue (queuesIdPut)

Use this API to update an existing queue by specifying the queue ID.

Path parameters

id (required)

Path Parameter — Specify the queue ID format: int64

Consumes

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

application/json

Request body

body Queue (required)

Body Parameter —

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 OK

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

500

Internal Server error Error

Up

post /queues/import

Import queues (queuesImportPost)

Use this API to import queues to the Control Room from a compressed file. Choose a file location and a password if needed. If a file already exists with the same name, you must specify if the file import must be skipped or a copy must be imported.

Consumes

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

multipart/form-data

Form parameters

upload (required)

Form Parameter — format: binary

encryptedPassword (required)

Form Parameter —

actionIfExists (required)

Form Parameter —

Return type

ImportQueueResponse

Example data

Content-Type: application/json

{
  "requestId" : "19bea097-afab-467f-bd25-1270e4c6f716"
}

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

202

Accepted ImportQueueResponse

400

Bad Request Error

500

Internal Server error Error

Up

post /queues/list

List all queues (queuesListPost)

Use this API to retrieve a list of all the queues. You can send an API request with or without filter parameters. An API request without any filter parameters specified, retrieves details of all the objects in the Control Room. You can use the filter parameters to retrieve specific set of file or folder objects, instead of fetching all objects in the Control Room. For more information, see <a href="https://docs.automationanywhere.com/bundle/enterprise-v2019/page/enterprise-cloud/topics/control-room/control-room-api/cloud-api-filter-request.html">Filtering, pagination, and sorting</a>.

Consumes

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

*/*

Request body

body FilterRequest (required)

Body Parameter —

Return type

QueueFilterResponse

Example data

Content-Type: application/json

{
  "page" : {
    "totalFilter" : 1,
    "total" : 10,
    "offset" : 0
  },
  "list" : [ {
    "workItemProcessingOrders" : [ {
      "sortDirection" : "asc",
      "columnId" : 2,
      "priority" : 1
    }, {
      "sortDirection" : "asc",
      "columnId" : 2,
      "priority" : 1
    } ],
    "autoRetryLimit" : 6,
    "updatedBy" : 97,
    "displayColumnIds" : [ "16", "17", "18" ],
    "description" : "Calculate bonus for each employee",
    "updatedOn" : "2025-07-25T06:20:04.163681Z",
    "markDuplicate" : true,
    "createdOn" : "2025-07-18T08:19:07.663681Z",
    "version" : 5,
    "disallowDuplicate" : true,
    "considerReactivationThreshold" : true,
    "reactivationThreshold" : 1,
    "manualProcessingTime" : 0,
    "createdBy" : 97,
    "name" : "Finance Queue",
    "manualProcessingTimeUnit" : "SECONDS",
    "tenantId" : 1,
    "workItemModelId" : 6,
    "id" : 9.0,
    "status" : "DRAFT"
  }, {
    "workItemProcessingOrders" : [ {
      "sortDirection" : "asc",
      "columnId" : 2,
      "priority" : 1
    }, {
      "sortDirection" : "asc",
      "columnId" : 2,
      "priority" : 1
    } ],
    "autoRetryLimit" : 6,
    "updatedBy" : 97,
    "displayColumnIds" : [ "16", "17", "18" ],
    "description" : "Calculate bonus for each employee",
    "updatedOn" : "2025-07-25T06:20:04.163681Z",
    "markDuplicate" : true,
    "createdOn" : "2025-07-18T08:19:07.663681Z",
    "version" : 5,
    "disallowDuplicate" : true,
    "considerReactivationThreshold" : true,
    "reactivationThreshold" : 1,
    "manualProcessingTime" : 0,
    "createdBy" : 97,
    "name" : "Finance Queue",
    "manualProcessingTimeUnit" : "SECONDS",
    "tenantId" : 1,
    "workItemModelId" : 6,
    "id" : 9.0,
    "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

A list of queues QueueFilterResponse

401

Authentication required Error

404

Not found Error

403

Unauthorized access Error

500

Internal Server error Error

Up

post /queues

Create a queue (queuesPost)

Use this API to create a queue which is a container of work items. Ensure that you have the Create queues or AAE_Queue Admin permission.

Consumes

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

application/json

Request body

body CreateQueue (required)

Body Parameter —

Return type

Queue

Example data

Content-Type: application/json

{
  "workItemProcessingOrders" : [ {
    "sortDirection" : "asc",
    "columnId" : 2,
    "priority" : 1
  }, {
    "sortDirection" : "asc",
    "columnId" : 2,
    "priority" : 1
  } ],
  "autoRetryLimit" : 6,
  "updatedBy" : 97,
  "displayColumnIds" : [ "16", "17", "18" ],
  "description" : "Calculate bonus for each employee",
  "updatedOn" : "2025-07-25T06:20:04.163681Z",
  "markDuplicate" : true,
  "createdOn" : "2025-07-18T08:19:07.663681Z",
  "version" : 5,
  "disallowDuplicate" : true,
  "considerReactivationThreshold" : true,
  "reactivationThreshold" : 1,
  "manualProcessingTime" : 0,
  "createdBy" : 97,
  "name" : "Finance Queue",
  "manualProcessingTimeUnit" : "SECONDS",
  "tenantId" : 1,
  "workItemModelId" : 6,
  "id" : 9.0,
  "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

201

Return created queue Queue

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

500

Internal Server error Error

WorkItemModels

Up

delete /workitemmodels/{id}

Delete a work item model by ID (workitemmodelsIdDelete)

Use this API to delete 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

String

Example data

Content-Type: application/json

"OK"

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

204

Return 'nocontent' String

404

Not found Error

500

Internal Server error Error

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

{
  "updatedBy" : 29,
  "createdBy" : 27,
  "name" : "Bonus Template",
  "tenantId" : 1,
  "attributes" : [ {
    "name" : "Employee Salary",
    "id" : 6.027456183070403,
    "type" : "NUMBER"
  }, {
    "name" : "Employee Salary",
    "id" : 6.027456183070403,
    "type" : "NUMBER"
  } ],
  "id" : 5.0,
  "updatedOn" : "2025-07-25T06:20:04.163681Z",
  "createdOn" : "2025-07-18T08:19:07.663681Z"
}

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/list

Get all work item models (workitemmodelsListPost)

Use this API to get a list of the work item models (also known as work item template or work item structure). Work item models can be associated with one or more queues. You can send an API request with or without filter parameters. An API request without any filter parameters specified, retrieves details of all the work items in the Control Room. You can use the filter parameters to retrieve specific work items. For more information, see <a href="https://docs.automationanywhere.com/bundle/enterprise-v2019/page/enterprise-cloud/topics/control-room/control-room-api/cloud-api-filter-request.html">Filtering, pagination, and sorting</a>.

Consumes

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

*/*

Request body

body FilterRequest (required)

Body Parameter —

Return type

WorkItemModelList

Example data

Content-Type: application/json

{
  "page" : {
    "totalFilter" : 1,
    "total" : 10,
    "offset" : 0
  },
  "list" : [ {
    "updatedBy" : 29,
    "createdBy" : 27,
    "name" : "Bonus Template",
    "tenantId" : 1,
    "attributes" : [ {
      "name" : "Employee Salary",
      "id" : 6.027456183070403,
      "type" : "NUMBER"
    }, {
      "name" : "Employee Salary",
      "id" : 6.027456183070403,
      "type" : "NUMBER"
    } ],
    "id" : 5.0,
    "updatedOn" : "2025-07-25T06:20:04.163681Z",
    "createdOn" : "2025-07-18T08:19:07.663681Z"
  }, {
    "updatedBy" : 29,
    "createdBy" : 27,
    "name" : "Bonus Template",
    "tenantId" : 1,
    "attributes" : [ {
      "name" : "Employee Salary",
      "id" : 6.027456183070403,
      "type" : "NUMBER"
    }, {
      "name" : "Employee Salary",
      "id" : 6.027456183070403,
      "type" : "NUMBER"
    } ],
    "id" : 5.0,
    "updatedOn" : "2025-07-25T06:20:04.163681Z",
    "createdOn" : "2025-07-18T08:19:07.663681Z"
  } ]
}

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 work item model array WorkItemModelList

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

{
  "updatedBy" : 29,
  "createdBy" : 27,
  "name" : "Bonus Template",
  "tenantId" : 1,
  "attributes" : [ {
    "name" : "Employee Salary",
    "id" : 6.027456183070403,
    "type" : "NUMBER"
  }, {
    "name" : "Employee Salary",
    "id" : 6.027456183070403,
    "type" : "NUMBER"
  } ],
  "id" : 5.0,
  "updatedOn" : "2025-07-25T06:20:04.163681Z",
  "createdOn" : "2025-07-18T08:19:07.663681Z"
}

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

workItemUploadResult

Example data

Content-Type: application/json

{
  "result" : "Success"
}

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 workItemUploadResult

401

Authentication required Error

404

Not found Error

403

Unauthorized access Error

500

Internal Server error Error

Up

post /queues/{id}/workitems/delete

Delete work items by ID (queuesIdWorkitemsDeletePost)

Use this API to delete multiple work items by specifying the IDs in the request body.

Path parameters

id (required)

Path Parameter — Queue ID format: int64

Consumes

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

*/*

Request body

body WorkItemRequest (required)

Body Parameter — Work item object

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

OK

401

Authentication required Error

404

Not found Error

403

Unauthorized access Error

500

Internal Server error Error

Up

post /queues/{id}/workitems/export

Export list work items (queuesIdWorkitemsExportPost)

Use this API to export work items to a file in the CSV format.

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

workitem_ids (required)

Form Parameter —

Return type

array[ExportResponse]

Example data

Content-Type: application/json

[ "19bea097-afab-467f-bd25-1270e4c6f716", "19bea097-afab-467f-bd25-1270e4c6f716" ]

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 request-id

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

404

Not found Error

500

Internal Server error Error

Up

post /queues/{id}/workitems/list

List work items (queuesIdWorkitemsListPost)

<p>Use this API to list work items for a given queue.</p> <p><strong>Note:</strong> The work items list API now limits responses to 1000 items or 300 MB, whichever is reached first. Requests exceeding these limits will fail. Reduce the number or size of your work item requests. For more information, refer to <a href="https://docs.automationanywhere.com/bundle/enterprise-v2019/page/v36-release-automation-workspace.html">Restricted work item size to prevent Out of Memory issue</a>.</p>

Path parameters

id (required)

Path Parameter — Queue ID format: int64

Consumes

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

application/json

Request body

body FilterRequest (required)

Body Parameter —

example:

{
  "value" : {
    "sort" : [ {
      "field" : "computedStatus",
      "direction" : "asc"
    } ],
    "filter" : {
      "operator" : "and",
      "operands" : [ {
        "field" : "status",
        "value" : "READY_TO_RUN",
        "operator" : "eq"
      }, {
        "field" : "comment",
        "operator" : "substring",
        "value" : "Bonus"
      } ]
    },
    "fields" : [ ],
    "page" : {
      "offset" : 0,
      "total" : 31199,
      "totalFilter" : 2,
      "length" : 100
    }
  }
}

Return type

array[WorkItemFilterResponse]

Example data

Content-Type: application/json

[ {
  "page" : {
    "totalFilter" : 1,
    "total" : 10,
    "offset" : 0
  },
  "list" : [ {
    "queueId" : 6.027456183070403,
    "automationId" : 1.4658129805029452,
    "totalPausedTime" : 5,
    "deferredUntil" : "2025-08-15T06:20:04.163681Z",
    "error" : "null",
    "deviceId" : 0.8008281904610115,
    "createdOn" : "2025-07-18T08:19:07.663681Z",
    "result" : "result",
    "hashCode" : -2081237442,
    "json" : {
      "Customer Name" : "Jane",
      "Invoice Id" : "INV123",
      "Amount" : "140",
      "Email" : "jane@automationanywhere.com",
      "Invoice Date" : "2025-01-10T00:18:48Z"
    },
    "startTime" : "2025-07-18T08:19:07.663681Z",
    "id" : 31250.0,
    "col2" : "Doe",
    "col3" : "45",
    "col1" : "Jane",
    "updatedBy" : 97,
    "jobExecutionId" : "null",
    "retryCount" : 2,
    "updatedOn" : "2025-07-25T06:20:04.163681Z",
    "version" : 7,
    "createdBy" : 97,
    "deviceUserId" : 5.962133916683182,
    "comment" : "Bonus workitems",
    "endTime" : "2025-07-20T06:29:07.663681Z",
    "status" : "READY_TO_RUN"
  }, {
    "queueId" : 6.027456183070403,
    "automationId" : 1.4658129805029452,
    "totalPausedTime" : 5,
    "deferredUntil" : "2025-08-15T06:20:04.163681Z",
    "error" : "null",
    "deviceId" : 0.8008281904610115,
    "createdOn" : "2025-07-18T08:19:07.663681Z",
    "result" : "result",
    "hashCode" : -2081237442,
    "json" : {
      "Customer Name" : "Jane",
      "Invoice Id" : "INV123",
      "Amount" : "140",
      "Email" : "jane@automationanywhere.com",
      "Invoice Date" : "2025-01-10T00:18:48Z"
    },
    "startTime" : "2025-07-18T08:19:07.663681Z",
    "id" : 31250.0,
    "col2" : "Doe",
    "col3" : "45",
    "col1" : "Jane",
    "updatedBy" : 97,
    "jobExecutionId" : "null",
    "retryCount" : 2,
    "updatedOn" : "2025-07-25T06:20:04.163681Z",
    "version" : 7,
    "createdBy" : 97,
    "deviceUserId" : 5.962133916683182,
    "comment" : "Bonus workitems",
    "endTime" : "2025-07-20T06:29:07.663681Z",
    "status" : "READY_TO_RUN"
  } ]
}, {
  "page" : {
    "totalFilter" : 1,
    "total" : 10,
    "offset" : 0
  },
  "list" : [ {
    "queueId" : 6.027456183070403,
    "automationId" : 1.4658129805029452,
    "totalPausedTime" : 5,
    "deferredUntil" : "2025-08-15T06:20:04.163681Z",
    "error" : "null",
    "deviceId" : 0.8008281904610115,
    "createdOn" : "2025-07-18T08:19:07.663681Z",
    "result" : "result",
    "hashCode" : -2081237442,
    "json" : {
      "Customer Name" : "Jane",
      "Invoice Id" : "INV123",
      "Amount" : "140",
      "Email" : "jane@automationanywhere.com",
      "Invoice Date" : "2025-01-10T00:18:48Z"
    },
    "startTime" : "2025-07-18T08:19:07.663681Z",
    "id" : 31250.0,
    "col2" : "Doe",
    "col3" : "45",
    "col1" : "Jane",
    "updatedBy" : 97,
    "jobExecutionId" : "null",
    "retryCount" : 2,
    "updatedOn" : "2025-07-25T06:20:04.163681Z",
    "version" : 7,
    "createdBy" : 97,
    "deviceUserId" : 5.962133916683182,
    "comment" : "Bonus workitems",
    "endTime" : "2025-07-20T06:29:07.663681Z",
    "status" : "READY_TO_RUN"
  }, {
    "queueId" : 6.027456183070403,
    "automationId" : 1.4658129805029452,
    "totalPausedTime" : 5,
    "deferredUntil" : "2025-08-15T06:20:04.163681Z",
    "error" : "null",
    "deviceId" : 0.8008281904610115,
    "createdOn" : "2025-07-18T08:19:07.663681Z",
    "result" : "result",
    "hashCode" : -2081237442,
    "json" : {
      "Customer Name" : "Jane",
      "Invoice Id" : "INV123",
      "Amount" : "140",
      "Email" : "jane@automationanywhere.com",
      "Invoice Date" : "2025-01-10T00:18:48Z"
    },
    "startTime" : "2025-07-18T08:19:07.663681Z",
    "id" : 31250.0,
    "col2" : "Doe",
    "col3" : "45",
    "col1" : "Jane",
    "updatedBy" : 97,
    "jobExecutionId" : "null",
    "retryCount" : 2,
    "updatedOn" : "2025-07-25T06:20:04.163681Z",
    "version" : 7,
    "createdBy" : 97,
    "deviceUserId" : 5.962133916683182,
    "comment" : "Bonus workitems",
    "endTime" : "2025-07-20T06:29:07.663681Z",
    "status" : "READY_TO_RUN"
  } ]
} ]

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

A list of work items

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

404

Not found Error

500

Internal Server error Error

Up

post /queues/{id}/workitems

Create new work items (queuesIdWorkitemsPost)

Use this API to add or insert work items to an existing queue that matches the work item model.

Path parameters

id (required)

Path Parameter — Queue ID format: int64

Consumes

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

*/*

Request body

body CreateWorkItem (required)

Body Parameter — List of work item objects

Return type

CreateWorkItemResponse

Example data

Content-Type: application/json

{
  "list" : [ {
    "queueId" : 6.027456183070403,
    "automationId" : 1.4658129805029452,
    "totalPausedTime" : 5,
    "deferredUntil" : "2025-08-15T06:20:04.163681Z",
    "error" : "null",
    "deviceId" : 0.8008281904610115,
    "createdOn" : "2025-07-18T08:19:07.663681Z",
    "result" : "result",
    "hashCode" : -2081237442,
    "json" : {
      "Customer Name" : "Jane",
      "Invoice Id" : "INV123",
      "Amount" : "140",
      "Email" : "jane@automationanywhere.com",
      "Invoice Date" : "2025-01-10T00:18:48Z"
    },
    "startTime" : "2025-07-18T08:19:07.663681Z",
    "id" : 31250.0,
    "col2" : "Doe",
    "col3" : "45",
    "col1" : "Jane",
    "updatedBy" : 97,
    "jobExecutionId" : "null",
    "retryCount" : 2,
    "updatedOn" : "2025-07-25T06:20:04.163681Z",
    "version" : 7,
    "createdBy" : 97,
    "deviceUserId" : 5.962133916683182,
    "comment" : "Bonus workitems",
    "endTime" : "2025-07-20T06:29:07.663681Z",
    "status" : "READY_TO_RUN"
  }, {
    "queueId" : 6.027456183070403,
    "automationId" : 1.4658129805029452,
    "totalPausedTime" : 5,
    "deferredUntil" : "2025-08-15T06:20:04.163681Z",
    "error" : "null",
    "deviceId" : 0.8008281904610115,
    "createdOn" : "2025-07-18T08:19:07.663681Z",
    "result" : "result",
    "hashCode" : -2081237442,
    "json" : {
      "Customer Name" : "Jane",
      "Invoice Id" : "INV123",
      "Amount" : "140",
      "Email" : "jane@automationanywhere.com",
      "Invoice Date" : "2025-01-10T00:18:48Z"
    },
    "startTime" : "2025-07-18T08:19:07.663681Z",
    "id" : 31250.0,
    "col2" : "Doe",
    "col3" : "45",
    "col1" : "Jane",
    "updatedBy" : 97,
    "jobExecutionId" : "null",
    "retryCount" : 2,
    "updatedOn" : "2025-07-25T06:20:04.163681Z",
    "version" : 7,
    "createdBy" : 97,
    "deviceUserId" : 5.962133916683182,
    "comment" : "Bonus workitems",
    "endTime" : "2025-07-20T06:29:07.663681Z",
    "status" : "READY_TO_RUN"
  } ]
}

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

A list of WorkItems CreateWorkItemResponse

401

Authentication required Error

404

Not found Error

403

Unauthorized access Error

500

Internal Server error Error

Up

delete /queues/{id}/workitems/{workItemId}

Delete work item (queuesIdWorkitemsWorkItemIdDelete)

Use this API to delete a specific work item by specifying the ID.

Path parameters

id (required)

Path Parameter — Queue ID format: int64

workItemId (required)

Path Parameter — WorkItem ID format: int64

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

204

Returns NO_CONTENTS

400

Bad Request Error

401

Authentication required Error

403

Unauthorized access Error

404

Not found Error

500

Internal Server error Error

Up

get /queues/{id}/workitems/{workItemId}

Get work item by ID (queuesIdWorkitemsWorkItemIdGet)

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

Path parameters

id (required)

Path Parameter — Queue ID format: int64

workItemId (required)

Path Parameter — WorkItem ID format: int64

Return type

WorkItem

Example data

Content-Type: application/json

{
  "queueId" : 6.027456183070403,
  "automationId" : 1.4658129805029452,
  "totalPausedTime" : 5,
  "deferredUntil" : "2025-08-15T06:20:04.163681Z",
  "error" : "null",
  "deviceId" : 0.8008281904610115,
  "createdOn" : "2025-07-18T08:19:07.663681Z",
  "result" : "result",
  "hashCode" : -2081237442,
  "json" : {
    "Customer Name" : "Jane",
    "Invoice Id" : "INV123",
    "Amount" : "140",
    "Email" : "jane@automationanywhere.com",
    "Invoice Date" : "2025-01-10T00:18:48Z"
  },
  "startTime" : "2025-07-18T08:19:07.663681Z",
  "id" : 31250.0,
  "col2" : "Doe",
  "col3" : "45",
  "col1" : "Jane",
  "updatedBy" : 97,
  "jobExecutionId" : "null",
  "retryCount" : 2,
  "updatedOn" : "2025-07-25T06:20:04.163681Z",
  "version" : 7,
  "createdBy" : 97,
  "deviceUserId" : 5.962133916683182,
  "comment" : "Bonus workitems",
  "endTime" : "2025-07-20T06:29:07.663681Z",
  "status" : "READY_TO_RUN"
}

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

Detail of workItems WorkItem

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}/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" : 6.027456183070403,
  "automationId" : 1.4658129805029452,
  "totalPausedTime" : 5,
  "deferredUntil" : "2025-08-15T06:20:04.163681Z",
  "error" : "null",
  "deviceId" : 0.8008281904610115,
  "createdOn" : "2025-07-18T08:19:07.663681Z",
  "result" : "result",
  "hashCode" : -2081237442,
  "json" : {
    "Customer Name" : "Jane",
    "Invoice Id" : "INV123",
    "Amount" : "140",
    "Email" : "jane@automationanywhere.com",
    "Invoice Date" : "2025-01-10T00:18:48Z"
  },
  "startTime" : "2025-07-18T08:19:07.663681Z",
  "id" : 31250.0,
  "col2" : "Doe",
  "col3" : "45",
  "col1" : "Jane",
  "updatedBy" : 97,
  "jobExecutionId" : "null",
  "retryCount" : 2,
  "updatedOn" : "2025-07-25T06:20:04.163681Z",
  "version" : 7,
  "createdBy" : 97,
  "deviceUserId" : 5.962133916683182,
  "comment" : "Bonus workitems",
  "endTime" : "2025-07-20T06:29:07.663681Z",
  "status" : "READY_TO_RUN"
}

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

Up

get /queues/workitems/export/download/{downloadFileId}

Download exported work items (queuesWorkitemsExportDownloadDownloadFileIdGet)

USe this API to download an exported work item file.

Path parameters

downloadFileId (required)

Path Parameter — Use the download file ID from the status API

Produces

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

text/csv

Responses

200

OK

400

Bad Request Error

500

Internal Server error Error

Up

get /queues/workitems/export/download/status/{requestId}

Get export status (queuesWorkitemsExportDownloadStatusRequestIdGet)

Use this API to retrieve status of the export by specifying the request ID.

Path parameters

requestId (required)

Path Parameter — Request ID

Return type

StatusResponse

Example data

Content-Type: application/json

{
  "downloadFileName" : "/crdata/Server Files/wlm-files/workitems/4090a32b-79c1-4fd8-b88a-b1ea8c994cb0/72b676eb-2801-47cb-91ea-5f71f06df0ba/cr-work-items-20250714-095032.csv",
  "requestId" : "50421ecb-9ce0-46e6-99ed-85ab623b5420",
  "errorMessage" : "null",
  "type" : "WORKITEM_EXPORT",
  "downloadFileId" : "72b676eb-2801-47cb-91ea-5f71f06df0ba",
  "status" : "IN_PROGRESS"
}

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

Details of export status StatusResponse

400

Bad Request Error

500

Internal Server error Error

Models

Methods

Table of Contents

Automation
Automation_resiliency
Automation_resiliency_common
Automation_resiliency_common_detectAndNotify
Automation_resiliency_common_recording
Automation_schedules
CompoundFilter
CreateAutomation
CreateAutomation_schedules
CreateInterval
CreateQueue
CreateWorkItem
CreateWorkItemResponse
Error
ExportQueueRequest
ExportQueueResponse
ExportRequest
ExportResponse
Filter
FilterRequest
Id
ImportQueueResponse
Interval
PageRequest
PageResponse
Queue
QueueConsumers
QueueFilterResponse
QueueMember
QueueMemberAdd
QueueMemberPermissions
Role
RoleId
SimpleFilter
Sort
StatusResponse
UpdateWorkItem
UpdateWorkItemResponse
WorkItem
WorkItemFilterResponse
WorkItemJson
WorkItemModel
WorkItemModelAttribute
WorkItemModelAttributeWithoutId
WorkItemModelList
WorkItemModelWithoutId
WorkItemProcessingOrder
WorkItemRequest
WorkitemsArray
body
body_1
body_2
workItemUploadResult

`Automation` Up

id

BigDecimal Unique identifier of the automation

example: 10.0

createdBy (optional)

BigDecimal ID of the user who has created the automation

example: 97.0

createdOn (optional)

String Date when the automation was created

example: 2025-07-18T08:19:07.663681Z

updatedBy (optional)

BigDecimal ID of the user who last updated the automation

example: 97.0

updatedOn (optional)

String Date when the automationwas last updated

example: 2025-07-25T06:20:04.163681Z

tenantId (optional)

BigDecimal The unique identifier for the tenant that is associated with the tenant. The tenant ID is assigned to the tenant's resources.

example: 1.0

version (optional)

BigDecimal Version of the automation

example: 0.0

name

String Name specified for the automation

example: Finance Automation

status (optional)

String Queue specific action

Enum:

ACTIVE

PAUSE

runElevated (optional)

Boolean Enable run with administrator privilleges

rdpEnabled (optional)

Boolean Enable or disable remote desktop protocol (RDP) for your automation.

description (optional)

String Description specified for the Automation

example: Automation to calculate finances

fileId

BigDecimal ID of the file

example: 0.0

botLabel (optional)

String The label of a bot

example: Bot

botVersion (optional)

BigDecimal The version of the bot

example: 0.0

runAsUserIds

array[BigDecimal] ID of the run as user

example: 97, 101

queueId

BigDecimal Unique ID of the queue

example: 12.0

poolId

BigDecimal Unique ID of the Pool of devices

example: 12.0

priority

BigDecimal Set priority to run the automation

example: 1.0

workItemsProcessed (optional)

BigDecimal

example: 4.0

averageProcessingTime (optional)

Double format: double

totalPausedTimeInSec (optional)

BigDecimal

example: 60.0

startedOn

String Time the automation was started on

example: 2025-07-18T06:19:07.663681Z

startedBy

BigDecimal Unique ID of the user who has started the automation

example: 97.0

handleUnexpectedPopups (optional)

Boolean Enable or disable dealing with unexpected or unplanned dialog boxes or windows that appear during the execution.

example: false

resiliency (optional)

Automation_resiliency

defaultDevices (optional)

Boolean

owner

BigDecimal The owner of an automation

example: 1.0

hideBotAgentUi (optional)

Boolean

tenantUuid (optional)

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

example: c0c31e64-f0ec-3754-424d-50422be0d52b

zoneId

String The local zone ID of the running automation.

example: America/Los_Angeles

schedules (optional)

Automation_schedules

`Automation_resiliency` Up

common

Automation_resiliency_common

`Automation_resiliency_common` Up

detectAndNotify

Automation_resiliency_common_detectAndNotify

recording

Automation_resiliency_common_recording

handleUnexpectedPopups

Boolean

`Automation_resiliency_common_detectAndNotify` Up

enabled

Boolean

hideSensitiveInformation

Boolean

`Automation_resiliency_common_recording` Up

enabled

Boolean

botStatus

String

example: FAILED

`Automation_schedules` Up

id

BigDecimal

example: 12.0

ordinal

BigDecimal Ordinal numder (such as 1, 2, 3) that indicates the ranking or order of the intervals.

example: 1.0

daysOfWeek

array[String] Days of the week like MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY

Enum:

intervals

array[Interval]

`CompoundFilter` Up

operator

String Logical operator.

Enum:

and

or

not

operands

array[Filter] Array of nested filter conditions.

`CreateAutomation` Up

name

String Name of the automation

example: Finance Automation

rdpEnabled (optional)

Boolean Enable or disable remote desktop protocol (RDP) for your automation.

runElevated (optional)

Boolean Enable run with administrator privilleges

description (optional)

String Description of the automation

example: Automation to calculate finances

botInput (optional)

Object Inputs required for the bot to execute. For more details on different bot inputs, see <a href="https://docs.automationanywhere.com/bundle/enterprise-v2019/page/deploy-api-supported.html">Bot deploy</a>.

status (optional)

String Queue specific action

Enum:

ACTIVE

PAUSE

fileId

BigDecimal The bot id of the associated bot

botLabel (optional)

String The label of a bot

example: Bot

botVersion (optional)

BigDecimal The version of the bot

example: 1.0

runAsUserIds

array[BigDecimal] List of ids of runAs users which could login to the devices to run automation

queueId

BigDecimal The queue id of the associated queue

example: 12.0

poolId

BigDecimal The pool id of the associated pool

example: 12.0

priority (optional)

BigDecimal The priority of this automation in case if automation is running in priority mode of the device pool

example: 1.0

handleUnexpectedPopups (optional)

Boolean Enable or disable dealing with unexpected or unplanned dialog boxes or windows that appear during the execution.

example: false

defaultDevices (optional)

Boolean Enable default device mode, runAs users will use default device to login and run automation

zoneId

String ID of the time zone from where the automation is scheduled.

example: Asia/Calcutta

schedules (optional)

CreateAutomation_schedules

`CreateAutomation_schedules` Up

ordinal

BigDecimal Ordinal numder (such as 1, 2, 3) that indicates the ranking or order of the intervals.

example: 1.0

daysOfWeek

array[String] Week days like MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY

Enum:

intervals

array[CreateInterval]

`CreateInterval` Up

startTime

String Start time of the interval specified for automation.

example: 22:15:00

endTime

String End time of the interval specified for automation.

example: 22:30:00

ordinal

BigDecimal Ordinal numder (such as 1, 2, 3) that indicates the ranking or order of the intervals.

example: 1.0

`CreateQueue` Up

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)

Integer Minimum number of workItems in the queue to reactivate queue

example: 1

manualProcessingTime (optional)

Integer efforts required to process the queue manually

disallowDuplicate (optional)

Boolean

autoRetryLimit (optional)

Integer

manualProcessingTimeUnit (optional)

String

Enum:

SECONDS

MINUTES

HOURS

DAYS

workItemModelId (optional)

Integer

example: 6

workItemProcessingOrders (optional)

array[WorkItemProcessingOrder]

displayColumnIds (optional)

array[Integer]

example: [16,17,18]

`CreateWorkItem` Up

workItems (optional)

array[WorkItemJson]

`CreateWorkItemResponse` Up

list (optional)

array[WorkItem]

`Error` Up

code (optional)

Integer Error code

message (optional)

String Message describing error

`ExportQueueRequest` Up

exportName

String Export package name

example: Finance Queue

encryptedPassword (optional)

String Encrypted archive password

example: 2R8vJNF5E5EfaTLxr3tWI7kjs+uBFYaIHnBRBdtEUdbLKRg5acLhH4I=

includeWorkItems

Boolean True if export archive should contain required workItems

example: true

queueIds

array[Integer] Queue ids to export

example: [1,2,3]

`ExportQueueResponse` Up

requestId

String UUID that can be used to get status of export request.

example: 19bea097-afab-467f-bd25-1270e4c6f716

`ExportRequest` Up

ExportRequest follows the filter request object to export work items

workitem_ids (optional)

WorkitemsArray

`ExportResponse` Up

Request ID

`Filter` Up

Filters the result based on operator, field, or value.

`FilterRequest` Up

Filter request, which includes filtering, sorting, and pagination rules

filter (optional)

Filter

sort (optional)

array[Sort] Sort directions

page (optional)

PageRequest

`Id` Up

id (optional)

BigDecimal ID of an object

`ImportQueueResponse` Up

requestId

String UUID that can be used to get status of import request.

example: 19bea097-afab-467f-bd25-1270e4c6f716

`Interval` Up

id

BigDecimal ID of the interval.

example: 1.0

startTime

String Start time of the interval specified for automation.

example: 22:15:00

endTime

String End time of the interval specified for automation.

example: 22:30:00

ordinal

BigDecimal Ordinal numder (such as 1, 2, 3) that indicates the ranking or order of the intervals.

example: 1.0

tenantUuid

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

example: c0c31e64-f0ec-3754-424d-50422be0d52b

`PageRequest` Up

Pagingation rules allows you to retrieve a limited collection of results or offset a collection of results.

offset (optional)

Integer Page starting index

total (optional)

Integer Total workitems items in the list

example: 7

length (optional)

Integer Page length

example: 100

`PageResponse` Up

Pagination response

offset (optional)

Integer Page starting index

total (optional)

Integer Total number of items

example: 10

totalFilter (optional)

Integer Total number of items matching filter

example: 1

`Queue` Up

id (optional)

BigDecimal Unique identifier representing a specific queue

example: 9.0

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)

Integer Minimum number of workItems in the queue to reactivate queue

example: 1

manualProcessingTime (optional)

Integer Efforts required to process the queue manually

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)

Integer Enter a re-try limit to automatically retry the queue in case of a failure

status (optional)

String Status of the queue

Enum:

DRAFT

IN_USE

NOT_IN_USE

workItemModelId (optional)

Integer ID of the work item model

example: 6

workItemProcessingOrders (optional)

array[WorkItemProcessingOrder]

displayColumnIds (optional)

array[Integer]

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

createdBy (optional)

Integer User ID who has created the queue

example: 97

createdOn (optional)

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

example: 2025-07-18T08:19:07.663681Z

updatedBy (optional)

Integer User ID who last updated the queue

example: 97

updatedOn (optional)

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

example: 2025-07-25T06:20:04.163681Z

tenantId (optional)

Integer Unique ID of the tenant

example: 1

version (optional)

Integer Version of the queue

considerReactivationThreshold (optional)

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

markDuplicate (optional)

Boolean Set true if you do not want duplicate work items in this queue. Else set false.

`QueueConsumers` Up

id (optional)

BigDecimal Unique identifier of the queue

example: 440.0

createdBy (optional)

String ID of the user who created the Bot/file

example: 97

createdOn (optional)

String Date when the role was created

example: 2025-07-18T08:19:07.663681Z

updatedBy (optional)

BigDecimal Id of the user who made a latest update to the role

example: 97.0

updatedOn (optional)

String Date when the role was last updated

example: 2025-07-25T06:20:04.163681Z

tenantId (optional)

String The unique identifier for the tenant that is associated with the tenant. The tenant ID is assigned to the tenant's resources.

example: 5

version (optional)

String File version

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

description (optional)

String Description of the queue

example: Finance queue to calculate bonus.

name (optional)

String Name of the queue

example: Finanace Queue

permissions (optional)

QueueMemberPermissions

countPrincipals (optional)

BigDecimal Total number of active directory principal users

example: 0.0

systemRole (optional)

Boolean System role specified

principals (optional)

array[Integer] List of principals

`QueueFilterResponse` Up

page (optional)

PageResponse

list (optional)

array[Queue] list of queues.

`QueueMember` Up

users (optional)

array[Integer]

`QueueMemberAdd` Up

id (optional)

BigDecimal Unique identifier representing a specific role

example: 456.0

permissions (optional)

QueueMemberPermissions

`QueueMemberPermissions` Up

Queue specific actions a given user is allowed to perform

`Role` Up

id (optional)

BigDecimal Unique identifier representing a specific role

example: 456.0

name

String Name of the role

example: bot_manager

`RoleId` Up

id (optional)

BigDecimal Unique identifier representing a specific role

example: 456.0

`SimpleFilter` Up

field

String Filtering field.

example: name

value

String Filter value

example: finance_workitem

operator

String Operator for simple comparison.

Enum:

NONE

lt

le

eq

ne

ge

gt

substring

example: substring

`Sort` Up

By default, search results are sorted in ascending order with respect to their IDs. An alternative sorting is specified by using the sort query parameter.

field (optional)

String Field name to sort by

example: computedStatus

direction (optional)

String Sorting direction

Enum:

asc

desc

`StatusResponse` Up

requestId

String Queue Request ID.

example: 50421ecb-9ce0-46e6-99ed-85ab623b5420

type

String

Enum:

WORKITEM_EXPORT

status

String

Enum:

IN_PROGRESS

COMPLETED

FAILED

downloadFileName

String File name that is same as downloaded exported file

example: /crdata/Server Files/wlm-files/workitems/4090a32b-79c1-4fd8-b88a-b1ea8c994cb0/72b676eb-2801-47cb-91ea-5f71f06df0ba/cr-work-items-20250714-095032.csv

downloadFileId (optional)

String file identifier that can be used to download exported file

example: 72b676eb-2801-47cb-91ea-5f71f06df0ba

errorMessage (optional)

String Shows error in case of failed operation.

`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

`WorkItem` Up

id (optional)

BigDecimal Unique identifier representing a specific workItem

example: 31250.0

deviceId (optional)

BigDecimal Reference key with device entity

queueId (optional)

BigDecimal Reference key with queue entity

automationId (optional)

BigDecimal Reference key with automation entity

status (optional)

String

Enum:

READY_TO_RUN

DATA_ERROR

UNKNOWN

STAGED

QUEUED

ACTIVE

UNSUCCESSFUL

SUCCESSFUL

ON_HOLD

startTime (optional)

String Start time in ISO 8601 format

example: 2025-07-18T08:19:07.663681Z

endTime (optional)

String Start time in ISO 8601 format

example: 2025-07-20T06:29: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

deviceUserId (optional)

BigDecimal Runas user ID who has access to the device

createdBy (optional)

Integer User ID who has created the work items

example: 97

createdOn (optional)

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

example: 2025-07-18T08:19:07.663681Z

updatedBy (optional)

Integer User ID who has last updated the work item

example: 97

updatedOn (optional)

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

example: 2025-07-25T06:20:04.163681Z

comment (optional)

String Comments added to the workitem

example: Bonus workitems

json (optional)

WorkItemJson

result (optional)

String output of workItem's processing

totalPausedTime (optional)

Integer Total pause time to process the workitems

error (optional)

String Error while processing workitem

deferredUntil (optional)

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

example: 2025-08-15T06:20:04.163681Z

jobExecutionId (optional)

String ID of the job successfully completed

retryCount (optional)

Integer The total number of times this work item has been retried.

hashCode (optional)

Integer Hash code of the workitem's contents

example: -2081237442

version (optional)

Integer Version of the workitem

`WorkItemFilterResponse` Up

page (optional)

PageResponse

list (optional)

array[WorkItem] list of workItems.

`WorkItemJson` Up

WorkItem as JSON object. There is a limitation in the list endpoints that it will return an empty JSON object, as a workaround you can call the Get work items by ID endpoint to get JSON parameters and their corresponding values.