openapi: 3.2.0
info:
  title: AWX Unified Job Templates API
  version: v2
  description: AWX API Documentation
  contact:
    email: ansible-community@redhat.com
  license:
    name: Apache License
tags:
- name: unified_job_templates
paths:
  /api/v2/unified_job_templates/:
    get:
      operationId: unified_job_templates_list
      parameters:
      - in: query
        name: order
        schema:
          type: string
        description: Order results by field name. Prefix with '-' for descending order. Supports comma-separated values for multiple fields.
      - in: query
        name: order_by
        schema:
          type: string
        description: Order results by field name. Prefix with '-' for descending order. Supports comma-separated values for multiple fields.
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: role_level
        schema:
          type: string
        description: Filter by role level for RBAC
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - in: query
        name: type
        schema:
          type: string
        description: Filter by object type. Supports comma-separated values for multiple types.
      tags:
      - unified_job_templates
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedUnifiedJobTemplateList'
          description: ''
      x-ai-description: Returns a paginated list of all unified job templates. Combines job templates, workflow templates, and project updates in a single view.
      summary: Unified job templates list
      x-summary-source: derived
components:
  schemas:
    UnifiedJobTemplate:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        type:
          type: string
          readOnly: true
        url:
          type: string
          readOnly: true
        related:
          type: string
          readOnly: true
        summary_fields:
          type: string
          readOnly: true
        created:
          type: string
          readOnly: true
        modified:
          type: string
          readOnly: true
        name:
          type:
          - string
          - 'null'
          maxLength: 512
        description:
          type:
          - string
          - 'null'
          default: ''
        last_job_run:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
        last_job_failed:
          type: boolean
          readOnly: true
        next_job_run:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
        status:
          enum:
          - new
          - pending
          - waiting
          - running
          - successful
          - failed
          - error
          - canceled
          - never updated
          - ok
          - missing
          - none
          - updating
          type: string
          description: '* `new` - New

            * `pending` - Pending

            * `waiting` - Waiting

            * `running` - Running

            * `successful` - Successful

            * `failed` - Failed

            * `error` - Error

            * `canceled` - Canceled

            * `never updated` - Never Updated

            * `ok` - OK

            * `missing` - Missing

            * `none` - No External Source

            * `updating` - Updating'
          x-spec-enum-id: b387d72f4f16647d
          readOnly: true
        execution_environment:
          type:
          - integer
          - 'null'
          description: The container image to be used for execution.
      required:
      - name
    PaginatedUnifiedJobTemplateList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/UnifiedJobTemplate'