automation-anywhere Allocations API

openapi: 3.2.0
info:
  title: Automation Anywhere API Task Execution Allocations API
  description: The Automation Anywhere API Task Execution API enables developers to invoke API Tasks — a specialized type of cloud-based bot designed to be called synchronously from external applications like a REST service.
  version: '2019'
  contact:
    name: Automation Anywhere Support
    url: https://support.automationanywhere.com
  termsOfService: https://www.automationanywhere.com/terms-of-service
servers:
- url: https://{controlRoomUrl}/orchestrator/v1/hotbot
  description: Automation Anywhere API Task Orchestrator
  variables:
    controlRoomUrl:
      default: your-control-room.automationanywhere.com
      description: Your Control Room hostname
security:
- bearerAuth: []
- xAuthorization: []
tags:
- name: Allocations
  description: List and manage API Task allocations within the Control Room
paths:
  /config:
    post:
      operationId: listApiTaskAllocations
      summary: List API Task allocations
      description: Returns a paginated list of all API Tasks that have been allocated (registered) for real-time execution within the Control Room. Administrators must allocate an API Task before developers can generate execution URLs for it. Use this endpoint to verify that a specific API Task is available before requesting access details.
      tags:
      - Allocations
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListAllocationsRequest'
      responses:
        '200':
          description: Paginated list of API Task allocations
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAllocationsResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    ListAllocationsRequest:
      type: object
      description: Pagination parameters for listing API Task allocations. Omit to retrieve the first page with default settings.
      properties:
        page:
          $ref: '#/components/schemas/PageRequest'
    ListAllocationsResponse:
      type: object
      description: Paginated list of API Task allocations registered in the Control Room
      properties:
        list:
          type: array
          description: Array of API Task allocation records
          items:
            $ref: '#/components/schemas/ApiTaskAllocation'
        page:
          $ref: '#/components/schemas/PageInfo'
    Error:
      type: object
      description: Standard error response
      properties:
        code:
          type: string
          description: Error code
        message:
          type: string
          description: Human-readable error description
    PageRequest:
      type: object
      description: Pagination parameters for list requests
      properties:
        offset:
          type: integer
          description: Zero-based starting index of the result page
          minimum: 0
          default: 0
        length:
          type: integer
          description: Number of records to return per page
          minimum: 1
          maximum: 100
          default: 100
    ApiTaskAllocation:
      type: object
      description: A single API Task allocation record indicating an allocated real-time API Task
      properties:
        fileId:
          type: integer
          description: Numeric file ID of the API Task bot in the repository
        filePath:
          type: string
          description: Repository path of the allocated API Task (e.g., /Automation/MyApiTask)
        fileName:
          type: string
          description: Display name of the API Task file
        runAsUserOrNone:
          type: integer
          description: User ID under which the API Task executes, or null if using the caller's credentials
        concurrencyLimit:
          type: integer
          description: Maximum number of concurrent instances allowed for this API Task in real-time execution mode
    PageInfo:
      type: object
      description: Pagination metadata in list responses
      properties:
        offset:
          type: integer
          description: Starting index of the returned results
        total:
          type: integer
          description: Total number of API Task allocations
        totalFilter:
          type: integer
          description: Total records after any filter criteria
  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
externalDocs:
  description: Automation Anywhere API Task Documentation
  url: https://docs.automationanywhere.com/bundle/enterprise-v2019/page/api-task-real-time-endpoint.html