Read and Review Automation Anywhere Documentation

Automation Anywhere Version 11.3

Close Contents

Contents

Open Contents

List all work items in a queue

  • Updated: 5/06/2020
    • 11.3.x
    • Explore
    • Enterprise
    • API docs

List all work items in a queue

Automation Anywhere provides a REST API that enables you to retrieve a list of work items in a given queue.

Prerequisites

AAE_Queue Admin role
You need a user account with the AAE_Queue Admin role to query and manage workload queues and work items in an Control Room.
JSON Web Token (JWT)
All Control Room APIs require a JSON Web Token (JWT) to access the APIs. Generate an authentication token using the Authentication API.
  • URL: https://<your_control_room_url>/v2/wlm/queues/{id}/workitems/list.
  • Method: POST.

Procedure

  1. Add an authentication token to the request header.
    Note: Use the Authentication API to generate a JSON Web Token.
  2. Enter the following parameters in the request body.

    There are 2 inputs required for this request.

    Id
    7
    Request body:
    {
      "filter": {
        "operator": "and",
        "operands": [
          {
            "field": "id",
            "operator": "gt",
            "value": "30800"
          },
          {
            "field": "id",
            "operator": "lt",
            "value": "30900"
          }
        ]
      },
      "page": {
        "length": 3,
        "offset": 0
      }
    }
  3. Send the request.
    • In a REST Client, click SEND.
    • In the Swagger interface, click Execute.
    Response body:
    {
      "page": {
        "offset": 0,
        "total": 229,
        "totalFilter": 12
      },
      "list": [
        {
          "id": "30888",
          "createdBy": "1",
          "createdOn": "2019-09-10T21:09:50.722Z",
          "updatedBy": "0",
          "updatedOn": "2019-09-10T21:13:46.304Z",
          "version": "5",
          "json": {
            "Invoice Id": "INV0004",
            "Customer Name": "APIName1",
            "Amount": 9007199254740991,
            "email": "API123@gmail.com",
            "Invoice Date": "2017-06-12T00:18:48Z"
          },
          "result": "",
          "deviceId": "3",
          "status": "SUCCESSFUL",
          "startTime": "2019-09-10T21:12:16.599Z",
          "endTime": "2019-09-10T21:13:17.062Z",
          "col1": "INV0004",
          "col2": "APIName1",
          "col3": "9.007199254740991E15",
          "col4": "API123@gmail.com",
          "col5": "2017-06-12T00:18:48Z",
          "deviceUserId": "0",
          "queueId": "7",
          "comment": "",
          "automationId": "6",
          "totalPausedTime": "0",
          "error": "",
          "col6": "",
          "col7": "",
          "col8": "",
          "col9": "",
          "col10": ""
        },
        {
          "id": "30889",
          "createdBy": "1",
          "createdOn": "2019-09-10T21:09:51.383Z",
          "updatedBy": "0",
          "updatedOn": "2019-09-10T21:13:46.255Z",
          "version": "5",
          "json": {
            "Invoice Id": "INV0004",
            "Customer Name": "APIName1",
            "Amount": 9007199254740991,
            "email": "API123@gmail.com",
            "Invoice Date": "2017-06-12T00:18:48Z"
          },
          "result": "",
          "deviceId": "4",
          "status": "SUCCESSFUL",
          "startTime": "2019-09-10T21:12:23.841Z",
          "endTime": "2019-09-10T21:13:24.265Z",
          "col1": "INV0004",
          "col2": "APIName1",
          "col3": "9.007199254740991E15",
          "col4": "API123@gmail.com",
          "col5": "2017-06-12T00:18:48Z",
          "deviceUserId": "0",
          "queueId": "7",
          "comment": "",
          "automationId": "6",
          "totalPausedTime": "0",
          "error": "",
          "col6": "",
          "col7": "",
          "col8": "",
          "col9": "",
          "col10": ""
        },
        {
          "id": "30890",
          "createdBy": "1",
          "createdOn": "2019-09-10T21:09:52.324Z",
          "updatedBy": "0",
          "updatedOn": "2019-09-10T21:13:46.347Z",
          "version": "5",
          "json": {
            "Invoice Id": "INV0004",
            "Customer Name": "APIName1",
            "Amount": 9007199254740991,
            "email": "API123@gmail.com",
            "Invoice Date": "2017-06-12T00:18:48Z"
          },
          "result": "",
          "deviceId": "5",
          "status": "SUCCESSFUL",
          "startTime": "2019-09-10T21:12:29.501Z",
          "endTime": "2019-09-10T21:13:30.102Z",
          "col1": "INV0004",
          "col2": "APIName1",
          "col3": "9.007199254740991E15",
          "col4": "API123@gmail.com",
          "col5": "2017-06-12T00:18:48Z",
          "deviceUserId": "0",
          "queueId": "7",
          "comment": "",
          "automationId": "6",
          "totalPausedTime": "0",
          "error": "",
          "col6": "",
          "col7": "",
          "col8": "",
          "col9": "",
          "col10": ""
        }
      ]
    }
    Response header:
     cache-control: no-cache, no-store, max-age=0, must-revalidate 
     connection: keep-alive 
     content-security-policy: default-src 'self' 
     content-type: application/json 
     date: Tue, 24 Sep 2019 19:40:09 GMT 
     expires: 0 
     pragma: no-cache 
     transfer-encoding: chunked 
     x-content-type-options: nosniff 
     x-frame-options: SAMEORIGIN 
     x-xss-protection: 1; mode=block 
Send Feedback