Read and Review Automation Anywhere Documentation

Automation 360

Close Contents

Contents

Open Contents

Create Work Item model API

  • Updated: 2020/09/10

    Create Work Item model API

    Define a Work Item structure (model) for processing in a queue. This enables you to manually upload the Work Item from the system in the absence of ready data in a file.

    Prerequisites

    You must have the following:

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

    Procedure

    1. Use the POST method and endpoint URL: <your_control_room_url>/v3/wlm/workitemmodels.
      Enter the parameters such as Work Item model name, attribute names, and type value in the request body to create a Work Item structure. The value of type can be TEXT, NUMBER, or DATE, depending on the attribute value format.
      For example:
      POST https://192.0.2.0/v3/wlm/workitemmodels

      In this example, the Work Item model name is Finance-template and it includes the first_name, last_name, and email as attributes. For these attributes, use TEXT value as the type parameter.

      Request body:
      {
        "name": "Finance-template",
        "attributes": [
          {
            "name": "first_name",
            "type": "TEXT"
          },
          {
            "name": "last_name",
            "type": "TEXT"
          },
          {
            "name": "email",
            "type": "TEXT"
          }
        ]
      }
    2. Send the request.
      When the request is successful, the Work Item model id and the display column id are returned in the response. You will use these IDs when you create queues.
      In this example, the response body returns the Work Item model id as 10 and the display column id as 59, 60, 61 for the first_name, last_name, and email, respectively.
      Response body:
      {
        "id": 10,
        "createdBy": 24,
        "createdOn": "2020-05-26T06:14:27.520336200Z",
        "updatedBy": 24,
        "updatedOn": "2020-05-26T06:14:27.520336200Z",
        "tenantId": 1,
        "version": 0,
        "tenantUuid": "4db5b32c-5c4b-4aee-8ca0-f53ec241563c",
        "name": "fin",
        "attributes": [
          {
            "id": 59,
            "name": "first_name",
            "type": "TEXT"
          },
          {
            "id": 60,
            "name": "last_name",
            "type": "TEXT"
          },
          {
            "id": 61,
            "name": "email",
            "type": "TEXT"
          }
        ]
      }
      The REST API responds to each request with an HTTP response code. For details about the response codes, see API response codes.

    Next steps

    Create queues

    Send Feedback