Read and Review Automation Anywhere Documentation

Automation 360

Close Contents

Contents

Open Contents

List Work Items in queue

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

List Work Items in queue

Use the Workload Management Work Item list API to get the list of all the Work Items in the queues that are associated with the specified Control Room.

Prerequisites

You must have the following:

  • Queue Consumer permission
  • An authentication token for a user registered in the Control Room

    Authentication API

  • The endpoint URL: <your_control_room_url>/v3/wlm/queues/{queueId}/workitems/list

Leave the request body blank to request information on all available Work Items. Add one or more filter parameters in the request body to limit the information returned from all available WLM Work Items.

Supported filterable parameters:
status
The status of queue for example: New, On hold, Failed, Completed, Data error, Active, and Ready to run.
  • Field: status
  • Type: string
{
   "filter": {
    "operator": "eq",
    "value": "ACTIVE",
    "field": "status"
    }  
}
result
The Work Item result string. For example, the Work Item was completed or skipped.
  • Field: result
  • Type: string
{
  "filter": {
    "operator": "substring",
    "value": "skipped",
    "field": "result"
  }
}
col
The column number corresponding to the custom column name. For example, email, firstname, and lastname.
  • Field: col
  • Type: string
{
  "filter": {
    "operator": "substring",
    "value": "Brian",
    "field": "col1"
  }
}

Procedure

  1. Use the POST method to generate an authentication JSON Web Token.
  2. Use the POST method and endpoint URL: <your_control_room_url>/v3/wlm/queues/{queueId}/workitems/list
    For example, enter the queueId as 20 in the following URL for which you want to get the Work Items:
    https://192.0.2.0/v3/wlm/queues/20/workitems/list
    Use filters in the request body to retrieve the list of all the Work Items that are in NEW status and have Brian in their first_name (col1).

    Request body:

    {
      "sort": [
        {
          "field": "computedStatus",
          "direction": "asc"
        }
      ],
      "filter": {
        "operator": "and",
        "operands": [
          {
            "operator": "eq",
            "value": "NEW",
            "field": "status"
          },
          {
            "operator": "substring",
            "value": "Brian",
            "field": "col1"
          }
        ]
      },
      "fields": [
        
      ],
      "page": {
        "offset": 0,
        "total": 5,
        "totalFilter": 1,
        "length": 100
      }
    }
  3. Send the request.
    • In the REST Client, click SEND.
    • In the Swagger interface, click Execute.
    The response returns all the details of the Work Item that has Brian in their first_name (col1) and status is NEW.
    Response body:
    {
      "page": {
        "offset": 0,
        "total": 5,
        "totalFilter": 1
      },
      "list": [
        {
          "id": "11804",
          "createdBy": "24",
          "createdOn": "2020-05-26T10:19:34.786711300Z",
          "updatedBy": "24",
          "updatedOn": "2020-05-26T10:19:34.786711300Z",
          "version": "1",
          "json": {
            "id": "1",
            "first_name": "Brian",
            "last_name": "Matthews",
            "email": "bmatthews0@example.com",
            "gender": "Male",
            "Address": "5773 Meadow Ridge Street",
            "Current Balance": "822034.72",
            "Current Card Type": "jcb",
            "Average Bank Balance": "$1,25,365.58 ",
            "Account Number": "1651249",
            "Amount Requested": "12750",
            "Recommended": "6375",
            "Phone": "8607826062"
          },
          "result": "",
          "deviceId": "0",
          "status": "NEW",
          "col1": "Brian",
          "col2": "Matthews",
          "col3": "bmatthews0@example.com",
          "col4": "",
          "col5": "",
          "deviceUserId": "0",
          "queueId": "20",
          "comment": "",
          "automationId": "0",
          "totalPausedTime": "0",
          "error": "",
          "col6": "",
          "col7": "",
          "col8": "",
          "col9": "",
          "col10": ""
        }
      ]
    }
Send Feedback