automation-anywhere WorkItemModels API

openapi: 3.2.0
info:
  title: Automation Anywhere Workload Management Work Item Models API
  description: The Automation Anywhere Workload Management API provides programmatic control over work item queues used to distribute high-volume automation workloads across multiple Bot Runner devices.
  version: v4
  contact:
    name: Automation Anywhere Support
    url: https://support.automationanywhere.com
  termsOfService: https://www.automationanywhere.com/terms-of-service
servers:
- url: https://{controlRoomUrl}/v4/wlm
  description: Automation Anywhere Control Room Workload Management v4
  variables:
    controlRoomUrl:
      default: your-control-room.automationanywhere.com
      description: Your Control Room hostname
security:
- bearerAuth: []
- xAuthorization: []
tags:
- name: WorkItemModels
  description: Create and retrieve work item data models defining queue schema
paths:
  /workitemmodels:
    post:
      operationId: createWorkItemModel
      summary: Create a work item model
      description: 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.
      tags:
      - WorkItemModels
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkItemModel'
      responses:
        '200':
          description: Work item model created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkItemModel'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /workitemmodels/{id}:
    get:
      operationId: getWorkItemModel
      summary: Get a work item model by ID
      description: Retrieves a specific work item model by its numeric identifier, including the full list of attributes defining the model's data schema.
      tags:
      - WorkItemModels
      parameters:
      - $ref: '#/components/parameters/ModelIdParam'
      responses:
        '200':
          description: Work item model details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkItemModel'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Work item model not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  parameters:
    ModelIdParam:
      name: id
      in: path
      required: true
      description: Unique numeric identifier of the work item model
      schema:
        type: integer
        format: int64
  schemas:
    WorkItemModel:
      type: object
      description: Schema definition for work items in a queue, specifying the attributes (columns) and their data types that each work item must contain.
      properties:
        id:
          type: integer
          format: int64
          description: Unique identifier of the work item model
        name:
          type: string
          description: Name of the work item model
        attributes:
          type: array
          description: List of attribute definitions making up the work item schema
          items:
            $ref: '#/components/schemas/WorkItemAttribute'
        createdBy:
          type: integer
          format: int64
          description: ID of the user who created this model
        createdOn:
          type: string
          format: date-time
          description: ISO 8601 timestamp when the model was created
        updatedBy:
          type: integer
          format: int64
          description: ID of the user who last modified this model
        updatedOn:
          type: string
          format: date-time
          description: ISO 8601 timestamp of the last modification
        version:
          type: integer
          description: Optimistic locking version number
        tenantId:
          type: integer
          format: int64
          description: Tenant identifier for multi-tenant deployments
        tenantUuid:
          type: string
          description: UUID of the tenant
    WorkItemAttribute:
      type: object
      description: A single named attribute in a work item model
      properties:
        id:
          type: integer
          format: int64
          description: Unique identifier of the attribute
        name:
          type: string
          description: Attribute name used as the column identifier in work items
        type:
          type: string
          description: Data type of the attribute value
          enum:
          - TEXT
          - NUMBER
          - DATE
          - BOOLEAN
        isRequired:
          type: boolean
          description: Whether this attribute must be provided when creating a work item
    Error:
      type: object
      description: Standard error response
      properties:
        code:
          type: string
          description: Error code
        message:
          type: string
          description: Human-readable error description
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT token obtained from the Authentication API
    xAuthorization:
      type: apiKey
      in: header
      name: X-Authorization
      description: JWT token obtained from the Authentication API, passed as X-Authorization header
externalDocs:
  description: Automation Anywhere Workload Management API v4 Documentation
  url: https://docs.automationanywhere.com/bundle/enterprise-v2019/page/wlm-api-supported-v4.html