Automation Anywhere · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Automation Anywhere Workload Management Work Items API

3 actions 3 updates phrasing extends openapi/automation-anywhere-work-items-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Automation Anywhere's API. It is a proposal applied on top of the contract, not a document Automation Anywhere publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/queues/{id}/workitems/{workItemId}'].put

$.paths['/queues/{id}/file'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Automation Anywhere Workload Management Work Items API
  version: 1.0.0
extends: openapi/automation-anywhere-work-items-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/queues/{id}/workitems/{workItemId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a work item's status or result
      effect: write
      questions:
      - Can I mark a work item in a queue as complete, failed or deferred?
      - Why does updating a work item need its current version number?
      instructions:
      - text: Set work item {workItemId} in queue {id} to status {status}.
        slots:
          workItemId: path.workItemId
          id: path.id
          status: requestBody.status
      - text: Record result {result} on work item {workItemId} in queue {id}.
        slots:
          result: requestBody.result
          workItemId: path.workItemId
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/queues/{id}/file'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk-create work items from a CSV or Excel file
      effect: write
      questions:
      - Can I load many work items into a queue from a spreadsheet?
      - What file formats can I upload to create work items in bulk?
      instructions:
      - text: Upload {file} to queue {id} to create work items.
        slots:
          file: requestBody.file
          id: path.id
      - text: Bulk-load the rows of a CSV into queue {id} as work items.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'