Read and Review Automation Anywhere Documentation

Automation 360

Close Contents

Contents

Open Contents

List Work Item models

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

List Work Item models

Use the Work Item model list API to get the list of all the Work Item templates 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/workitemmodels/list

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/workitemmodels/list.
    Use the following URL and leave the request body blank to request information about all available Work Item models:
    https://192.0.2.0/v3/wlm/workitemmodels/list

    Request body:

    {}
  3. Send the request.
    • In the REST Client, click SEND.
    • In the Swagger interface, click Execute.
    Because there is no filtering used in the request, a successful response returns all of the queues for the specified Control Room. In this example, the response returned data for two Work Item models.
    Response body:
    {
      "page": {
        "offset": 0,
        "total": 50,
        "totalFilter": 50
      },
      "list": [
        {
          "id": "1",
          "name": "q1",
          "attributes": [
            {
              "name": "Customer Name",
              "type": "TEXT",
              "id": "2"
            },
            {
              "name": "email",
              "type": "TEXT",
              "id": "4"
            },
          ]
        },
        {
          "id": "2",
          "name": "q2",
          "attributes": [
            {
              "name": "Customer Name",
              "type": "TEXT",
              "id": "7"
            },
            {
              "name": "email",
              "type": "TEXT",
              "id": "9"
            },
            
          ]
        }
Send Feedback