Add Work Items to the queue API

Add or insert Work Items to an existing queue in the Control Room per the defined model or structure.

Prerequisiti

The user must be a Queue owner and participant
You must have the endpoint URLs:
- <your_control_room_url>/v3/wlm/queues/{queueId}/workitems
- <your_control_room_url>/v3/wlm/queues/list

Procedura

Use the POST method and endpoint URL: <your_control_room_url>/v3/wlm/queues/{queueId}/workitems.
Enter the queueId to which you want to add a Work Item in the queue.
Nota: If you want to search or get a list of all the available queueId, use the endpoint URL <your_control_room_url>/v3/wlm/queues/list.
List WLM queues
For example, use queueId as 17.
```
POST https://192.0.2.0/v3/wlm/queues/17/workitems
```
Enter a workitem in the request body.
Nota: In the request body, ensure there are no hidden, invalid, new line, or EOL characters. You can check for these using text or source code editors.
Request body:
```
{
  "workItems": [
    {
      "json": {
        "first_name": "Jane",
        "last_name": "Doe",
        "email": "jane.doe@example.com"
      }
    }
  ]
}
```

Send the request.

When the request is successful , a unique Work Item id is returned in the response body and the Work Items are added to the queue per the defined Work Item model or structure.

In this example, the Work Item with the first_name as Jane, last_name as Doe, and email as jane.doe@example.com is added to the queue based on the defined structure.

Response body: (truncated output)

{
  "id": 77,
  "createdBy": 24,
  "createdOn": "2020-05-19T17:41:57.602092100Z",
  "updatedby": 24,
  "updatedOn": "2020-05-26T09:13:31.090241700Z",
  "version": 2,
  "json": {
    "first_name": "Jane",
    "last_name": "Doe",
    "email": "jane.doe@example.com"
  },
  "result": "",
  "deviceId": 0,
  "status": "NEW",
  "col1": "1.0",
  "col2": "",
    ... 
  "co21": "",
  "deviceUserId": 0,
  "queueId": 5,
  "comment": "",
  "automationId": 0,
  "totalPausedTime": 0,
  "error": ""
}

Opzionale: If you want to add multiple Work Items, call the API using a list of Work Item JSON objects.

Request body:

{
  "workItems": [
    {
      "json": {
        "DATA": "mydata",
        "TRN_ID": "A11"
      }
    },
    {
      "json": {
        "DATA": "mydata",
        "TRN_ID": "A11"
      }
    }
  ]
}

Response body:

{
    "list": [
        {
            "id": "40957",
            "createdBy": "25",
            "createdOn": "2021-11-24T01:53:10.175335900Z",
            "updatedBy": "25",
            "updatedOn": "2021-11-24T01:53:10.175335900Z",
            "version": "0",
            "json": {
                "TRN_ID": "A11",
                "DATA": "mydata"
            },
            "result": "",
            "deviceId": "0",
            "status": "NEW",
            "col1": "A11",
            "col2": "",
            "col3": "",
            "col4": "",
            "col5": "",
            "deviceUserId": "0",
            "queueId": "0",
            "comment": "",
            "automationId": "0",
            "totalPausedTime": "0",
            "error": "",
            "col6": "",
            "col7": "",
            "col8": "",
            "col9": "",
            "col10": "",
            "jobExecutionId": ""
        },
        {
            "id": "40958",
            "createdBy": "25",
            "createdOn": "2021-11-24T01:53:10.198337200Z",
            "updatedBy": "25",
            "updatedOn": "2021-11-24T01:53:10.198337200Z",
            "version": "0",
            "json": {
                "TRN_ID": "A11",
                "DATA": "mydata"
            },
            "result": "",
            "deviceId": "0",
            "status": "NEW",
            "col1": "A11",
            "col2": "",
            "col3": "",
            "col4": "",
            "col5": "",
            "deviceUserId": "0",
            "queueId": "0",
            "comment": "",
            "automationId": "0",
            "totalPausedTime": "0",
            "error": "",
            "col6": "",
            "col7": "",
            "col8": "",
            "col9": "",
            "col10": "",
            "jobExecutionId": ""
        }
    ]
}

Opzionale: If you want to update the Work Item data, when the automation is running, you need to perform the following steps:
1. Pause the automation. Use the PUT method and the following endpoint URL: <your_control_room_url>/v3/wlm/automations/{id}
2. Update the Work Item by using queue ID and Work Item ID. Use the PUT method and the following endpoint URL: <your_control_room_url>/v3/wlm/queues/{id}/workitems/{workitemId}
3. Resume the automation. Use the PUT method and the following endpoint URL: <your_control_room_url>/v3/wlm/automations/{id}

Fasi successive

Create an automation to run a bot with a queue

Automation 360