Read and Review Automation Anywhere Documentation

Automation 360

Close Contents

Contents

Open Contents

Create queues API

  • Updated: 9/09/2020
    • Automation 360 v.x
    • Manage
    • RPA Workspace
    • API docs

Create queues API

A queue is one of the main building blocks of workload management (WLM). It holds specific sets of data that your bot is expecting for automation.

Prerequisites

Ensure you have the following:

  • Create queues or AAE_Queue Admin permission
  • The endpoint URLs:
    • <your_control_room_url>/v3/wlm/queues
    • <your_control_room_url>/v3/wlm/workitemmodels/list

Procedure

  1. Use the POST method and endpoint URL: <your_control_room_url>/v3/wlm/queues.
    Enter values for the following parameters to create a queue. Use the same workItemModelId and displayColumnIds that you received in response when you created the Work Item model.
    Note: If you want to search or get a list of all the available workItemModelId, use the endpoint URL <your_control_room_url>/v3/wlm/workitemmodels/list.

    List WLM queues

    For example:
    POST https://192.0.2.0/v3/wlm/queues

    In this example, use workItemModelId as 10 and displayColumnIds as 59, 60, 61.

    Request body:
    {
      "name": "Finance-Q",
      "description": "Queue for Finance",
      "reactivationThreshold": 1,
      "displayColumns": [
        "first_name",
        "last_name",
        "email"
      ],
      "workItemProcessingOrders": [
        
      ],
      "workItemModelId": 10,
      "displayColumnIds": [
        59,
        60,
        61
      ]
    }
  2. Send the request.
    When the request is successful, a queue id is returned in the response body. This queue id will be used in the subsequent tasks when you add owners, participants, consumers, and Work Items in the queue.
    In this example, the response body returns the queue id as 17.
    Response body:
    {
      "id": "17",
      "createdBy": "24",
      "createdOn": "2020-05-26T06:13:57.644499300Z",
      "updatedBy": "24",
      "updatedOn": "2020-05-26T06:13:57.644499300Z",
      "tenantId": "1",
      "version": "0",
      "tenantUuid": "4db5b56c-5c2b-4aee-8ca0-f53ec241563c",
      "name": "Finance-Q",
      "description": "Queue for Finance",
      "reactivationThreshold": "1",
      "status": "NOT_IN_USE",
      "manualProcessingTime": "0",
      "manualProcessingTimeUnit": "",
      "workItemProcessingOrders": [
        
      ],
      "workItemModelId": "10",
      "displayColumnIds": [
        "59",
        "60",
        "61"
      ],
      "considerReactivationThreshold": false
    }
    The REST API responds to each request with an HTTP response code. For details about the response codes, see API response codes.

Next steps

Add queue owner or member

Send Feedback