automation-anywhere

opencollection: 1.0.0
info:
  name: Automation Anywhere Workload Management API
  version: v4
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: WorkItemModels
    type: folder
  items:
  - info:
      name: Create a work item model
      type: http
    http:
      method: POST
      url: https://{controlRoomUrl}/v4/wlm/workitemmodels
      body:
        type: json
        data: '{}'
    docs: Creates a new work item model that defines the data schema for work items in associated queues. A work item model
      specifies the attribute names and types that each work item must contain, enabling structured data processing by bots.
  - info:
      name: Get a work item model by ID
      type: http
    http:
      method: GET
      url: https://{controlRoomUrl}/v4/wlm/workitemmodels/:id
      params:
      - name: id
        value: ''
        type: path
        description: Unique numeric identifier of the work item model
    docs: Retrieves a specific work item model by its numeric identifier, including the full list of attributes defining the
      model's data schema.
- info:
    name: Queues
    type: folder
  items:
  - info:
      name: Get a queue by ID
      type: http
    http:
      method: GET
      url: https://{controlRoomUrl}/v4/wlm/queues/:id
      params:
      - name: id
        value: ''
        type: path
        description: Unique numeric identifier of the queue
    docs: Retrieves detailed information about a specific work item queue, including its configuration, associated work item
      model, processing order, and current status.
  - info:
      name: Add a queue consumer
      type: http
    http:
      method: POST
      url: https://{controlRoomUrl}/v4/wlm/queues/:id/consumers
      params:
      - name: id
        value: ''
        type: path
        description: Unique numeric identifier of the queue
      body:
        type: json
        data: '{}'
    docs: Adds a role as a consumer of the specified queue. Consumer roles are assigned to bots that will process work items
      from the queue. Only users with queue management permissions can add consumers.
  - info:
      name: Add or update a queue member
      type: http
    http:
      method: PUT
      url: https://{controlRoomUrl}/v4/wlm/queues/:id/members/:userId
      params:
      - name: id
        value: ''
        type: path
        description: Unique numeric identifier of the queue
      - name: userId
        value: ''
        type: path
        description: Unique numeric identifier of the user
      body:
        type: json
        data: '{}'
    docs: Adds a user as a member of the specified queue or updates the existing membership configuration. Queue members are
      human users who can manage queue operations such as reviewing failed items.
  - info:
      name: Add a queue participant
      type: http
    http:
      method: POST
      url: https://{controlRoomUrl}/v4/wlm/queues/:id/participants
      params:
      - name: id
        value: ''
        type: path
        description: Unique numeric identifier of the queue
      body:
        type: json
        data: '{}'
    docs: Adds a participant to the specified queue. Participants can view queue status and work item data but have limited
      management permissions compared to queue owners or members.
- info:
    name: WorkItems
    type: folder
  items:
  - info:
      name: Update a work item
      type: http
    http:
      method: PUT
      url: https://{controlRoomUrl}/v4/wlm/queues/:id/workitems/:workItemId
      params:
      - name: id
        value: ''
        type: path
        description: Unique numeric identifier of the queue
      - name: workItemId
        value: ''
        type: path
        description: Unique numeric identifier of the work item
      body:
        type: json
        data: '{}'
    docs: Updates the status, result, or JSON data payload of an existing work item in the queue. Used by bots and administrators
      to mark work items as complete, failed, or deferred, and to store processing results.
  - info:
      name: Create work items from a file
      type: http
    http:
      method: POST
      url: https://{controlRoomUrl}/v4/wlm/queues/:id/file
      params:
      - name: id
        value: ''
        type: path
        description: Unique numeric identifier of the queue
      body:
        type: multipart-form
        data:
        - name: file
          type: text
          value: ''
    docs: Bulk-creates work items in a queue by uploading a CSV or Excel file. Each row in the file becomes a work item mapped
      to the queue's work item model attributes. This is the recommended approach for high-volume data ingestion into RPA
      queues.
bundled: true