openapi: 3.2.0
info:
  title: AWX Job Templates API
  version: v2
  description: AWX API Documentation
  contact:
    email: ansible-community@redhat.com
  license:
    name: Apache License
tags:
- name: Job Templates
paths:
  /api/v2/job_templates/:
    get:
      operationId: 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:
      - Job Templates
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedJobTemplateList'
          description: ''
      x-ai-description: Returns a paginated list of all job templates. A job template defines the playbook, inventory, credentials, and settings for launching a job.
      summary: Job templates list
      x-summary-source: derived
    post:
      operationId: job_templates_create
      tags:
      - Job Templates
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JobTemplateRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobTemplate'
          description: ''
      x-ai-description: Create a new job template. A job template defines the playbook, inventory, credentials, variables, and settings needed to launch an automation job.
      summary: Job templates create
      x-summary-source: derived
  /api/v2/job_templates/{id}/:
    get:
      operationId: job_templates_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - Job Templates
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobTemplate'
          description: ''
      x-ai-description: Retrieve a job template
      summary: Job templates retrieve
      x-summary-source: derived
    put:
      operationId: job_templates_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - Job Templates
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JobTemplateRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobTemplate'
          description: ''
      x-ai-description: Update a job template
      summary: Job templates update
      x-summary-source: derived
    patch:
      operationId: job_templates_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - Job Templates
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedJobTemplateRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobTemplate'
          description: ''
      x-ai-description: Update a job template
      summary: Job templates partial update
      x-summary-source: derived
    delete:
      operationId: job_templates_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - Job Templates
      responses:
        '204':
          description: No response body
      x-ai-description: Delete a job template
      summary: Job templates destroy
      x-summary-source: derived
  /api/v2/job_templates/{id}/access_list/:
    get:
      operationId: job_templates_access_list_list
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      - 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:
      - Job Templates
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedResourceAccessListElementList'
          description: ''
      x-ai-description: List users who can access a job template
      summary: Job templates access list list
      x-summary-source: derived
  /api/v2/job_templates/{id}/activity_stream/:
    get:
      operationId: job_templates_activity_stream_list
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      - 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:
      - Job Templates
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedActivityStreamList'
          description: ''
      x-ai-description: List activity stream of a job template
      summary: Job templates activity stream list
      x-summary-source: derived
  /api/v2/job_templates/{id}/bitbucket_dc/:
    post:
      operationId: job_templates_bitbucket_dc_create
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - Job Templates
      security:
      - {}
      responses:
        '200':
          description: No response body
      x-ai-description: Receive a webhook event and trigger a job
      summary: Job templates bitbucket dc create
      x-summary-source: derived
  /api/v2/job_templates/{id}/callback/:
    get:
      operationId: job_templates_callback_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - Job Templates
      responses:
        '200':
          description: No response body
      x-ai-description: Get job template callback configuration
      summary: Job templates callback retrieve
      x-summary-source: derived
    post:
      operationId: job_templates_callback_create
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - Job Templates
      responses:
        '200':
          description: No response body
      x-ai-description: Trigger job template via provisioning callback
      summary: Job templates callback create
      x-summary-source: derived
  /api/v2/job_templates/{id}/copy/:
    get:
      operationId: job_templates_copy_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - Job Templates
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Copy'
          description: ''
      x-ai-description: Retrieve a copy a job template
      summary: Job templates copy retrieve
      x-summary-source: derived
    post:
      operationId: job_templates_copy_create
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - Job Templates
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CopyRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Copy'
          description: ''
      x-ai-description: Create a copy a job template
      summary: Job templates copy create
      x-summary-source: derived
  /api/v2/job_templates/{id}/credentials/:
    get:
      operationId: job_templates_credentials_list
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      - 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:
      - Job Templates
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedCredentialList'
          description: ''
      x-ai-description: List credentials of a job template
      summary: Job templates credentials list
      x-summary-source: derived
    post:
      operationId: job_templates_credentials_create
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - Job Templates
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CredentialRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Credential'
          description: ''
      x-ai-description: Associate a credential with a job template. The credential will be used when launching jobs from this template.
      summary: Job templates credentials create
      x-summary-source: derived
  /api/v2/job_templates/{id}/github/:
    post:
      operationId: job_templates_github_create
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - Job Templates
      security:
      - {}
      responses:
        '200':
          description: No response body
      x-ai-description: Receive a webhook event and trigger a job
      summary: Job templates github create
      x-summary-source: derived
  /api/v2/job_templates/{id}/gitlab/:
    post:
      operationId: job_templates_gitlab_create
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - Job Templates
      security:
      - {}
      responses:
        '200':
          description: No response body
      x-ai-description: Receive a webhook event and trigger a job
      summary: Job templates gitlab create
      x-summary-source: derived
  /api/v2/job_templates/{id}/instance_groups/:
    get:
      operationId: job_templates_instance_groups_list
      description: Derived version of SubListCreateAttachDetachAPIView that prohibits creation
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      - 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:
      - Job Templates
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedInstanceGroupList'
          description: ''
      x-ai-description: List instance groups of a job template
      summary: Job templates instance groups list
      x-summary-source: derived
    post:
      operationId: job_templates_instance_groups_create
      description: Derived version of SubListCreateAttachDetachAPIView that prohibits creation
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - Job Templates
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InstanceGroupRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstanceGroup'
          description: ''
      x-ai-description: Create an instance group of a job template
      summary: Job templates instance groups create
      x-summary-source: derived
  /api/v2/job_templates/{id}/jobs/:
    get:
      operationId: job_templates_jobs_list
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      - 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:
      - Job Templates
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedJobListList'
          description: ''
      x-ai-description: List jobs of a job template
      summary: Job templates jobs list
      x-summary-source: derived
  /api/v2/job_templates/{id}/labels/:
    get:
      operationId: job_templates_labels_list
      description: 'For related labels lists like /api/v2/inventories/N/labels/


        We want want the last instance to be deleted from the database

        when the last disassociate happens.


        Subclasses need to define parent_model'
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      - 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:
      - Job Templates
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedLabelList'
          description: ''
      x-ai-description: List labels of a job template
      summary: Job templates labels list
      x-summary-source: derived
    post:
      operationId: job_templates_labels_create
      description: 'For related labels lists like /api/v2/inventories/N/labels/


        We want want the last instance to be deleted from the database

        when the last disassociate happens.


        Subclasses need to define parent_model'
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - Job Templates
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LabelRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Label'
          description: ''
      x-ai-description: Create or attach a label to a resource
      summary: Job templates labels create
      x-summary-source: derived
  /api/v2/job_templates/{id}/launch/:
    get:
      operationId: job_templates_launch_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - Job Templates
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobLaunch'
          description: ''
      x-ai-description: Returns the launch configuration and required fields needed to launch a specific job template by ID.
      summary: Job templates launch retrieve
      x-summary-source: derived
    post:
      operationId: job_templates_launch_create
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - Job Templates
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JobLaunchRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobLaunch'
          description: ''
      x-ai-description: Launch a job from a job template by ID. Starts execution of the playbook defined in the template.
      summary: Job templates launch create
      x-summary-source: derived
  /api/v2/job_templates/{id}/notification_templates_error/:
    get:
      operationId: job_templates_notification_templates_error_list
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      - 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:
      - Job Templates
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedNotificationTemplateList'
          description: ''
      x-ai-description: List notification templates triggered on job error
      summary: Job templates notification templates error list
      x-summary-source: derived
    post:
      operationId: job_templates_notification_templates_error_create
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - Job Templates
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationTemplateRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationTemplate'
          description: ''
      x-ai-description: Attach a notification template to trigger when a job from this template fails.
      summary: Job templates notification templates error create
      x-summary-source: derived
  /api/v2/job_templates/{id}/notification_templates_started/:
    get:
      operationId: job_templates_notification_templates_started_list
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      - 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:
      - Job Templates
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedNotificationTemplateList'
          description: ''
      x-ai-description: List notification templates triggered on job start
      summary: Job templates notification templates started list
      x-summary-source: derived
    post:
      operationId: job_templates_notification_templates_started_create
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - Job Templates
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationTemplateRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationTemplate'
          description: ''
      x-ai-description: Attach a notification template to trigger when a job from this template starts.
      summary: Job templates notification templates started create
      x-summary-source: derived
  /api/v2/job_templates/{id}/notification_templates_success/:
    get:
      operationId: job_templates_notification_templates_success_list
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      - 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:
      - Job Templates
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedNotificationTemplateList'
          description: ''
      x-ai-description: List notification templates triggered on job success
      summary: Job templates notification templates success list
      x-summary-source: derived
    post:
      operationId: job_templates_notification_templates_success_create
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - Job Templates
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationTemplateRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationTemplate'
          description: ''
      x-ai-description: Attach a notification template to trigger when a job from this template succeeds.
      summary: Job templates notification templates success create
      x-summary-source: derived
  /api/v2/job_templates/{id}/object_roles/:
    get:
      operationId: job_templates_object_roles_list
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      - 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:
      - Job Templates
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedRoleList'
          description: ''
      x-ai-description: List roles of a job template
      summary: Job templates object roles list
      x-summary-source: derived
  /api/v2/job_templates/{id}/schedules/:
    get:
      operationId: job_templates_schedules_list
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      - 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:
      - Job Templates
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedScheduleList'
          description: ''
      x-ai-description: List schedules of a job template
      summary: Job templates schedules list
      x-summary-source: derived
    post:
      operationId: job_templates_schedules_create
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - Job Templates
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScheduleRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Schedule'
          description: ''
      x-ai-description: Create a schedule of a job template
      summary: Job templates schedules create
      x-summary-source: derived
  /api/v2/job_templates/{id}/slice_workflow_jobs/:
    get:
      operationId: job_templates_slice_workflow_jobs_list
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      - 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:
      - Job Templates
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedWorkflowJobListList'
          description: ''
      x-ai-description: List all jobs for a job_template
      summary: Job templates slice workflow jobs list
      x-summary-source: derived
    post:
      operationId: job_templates_slice_workflow_jobs_create
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - Job Templates
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkflowJobListRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowJobList'
          description: ''
      x-ai-description: Create new job for a job_template
      summary: Job templates slice workflow jobs create
      x-summary-source: derived
  /api/v2/job_templates/{id}/survey_spec/:
    get:
      operationId: job_templates_survey_spec_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - Job Templates
      responses:
        '200':
          description: No response body
      x-ai-description: Get job template survey specification
      summary: Job templates survey spec retrieve
      x-summary-source: derived
    post:
      operationId: job_templates_survey_spec_create
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - Job Templates
      responses:
        '200':
          description: No response body
      x-ai-description: Create or update the survey specification for a job template. Surveys prompt users for input variables at launch time.
      summary: Job templates survey spec create
      x-summary-source: derived
    delete:
      operationId: job_templates_survey_spec_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - Job Templates
      responses:
        '204':
          description: No response body
      x-ai-description: Delete job template survey specification
      summary: Job templates survey spec destroy
      x-summary-source: derived
  /api/v2/job_templates/{id}/webhook_key/:
    get:
      operationId: job_templates_webhook_key_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - Job Templates
      responses:
        '200':
          description: No response body
      x-ai-description: Get the webhook key for a template
      summary: Job templates webhook key retrieve
      x-summary-source: derived
    post:
      operationId: job_templates_webhook_key_create
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - Job Templates
      responses:
        '200':
          description: No response body
      x-ai-description: Rotate the webhook key for a template
      summary: Job templates webhook key create
      x-summary-source: derived
components:
  schemas:
    PaginatedCredentialList:
      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/Credential'
    CopyRequest:
      type: object
      properties:
        name:
          type: string
          minLength: 1
      required:
      - name
    JobTemplateRequest:
      type: object
      description: Provide recent jobs and survey details in summary_fields
      properties:
        name:
          type:
          - string
          - 'null'
          minLength: 1
          maxLength: 512
        description:
          type:
          - string
          - 'null'
          default: ''
        job_type:
          enum:
          - run
          - check
          - null
          type:
          - string
          - 'null'
          description: '* `run` - Run

            * `check` - Check'
          x-spec-enum-id: 726608a431c1f104
          default: run
        inventory:
          type:
          - integer
          - 'null'
        project:
          type:
          - integer
          - 'null'
        playbook:
          type:
          - string
          - 'null'
          default: ''
          maxLength: 1024
        scm_branch:
          type:
          - string
          - 'null'
          default: ''
          description: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true.
          maxLength: 1024
        forks:
          type: integer
          maximum: 9223372036854775807
          minimum: 0
          format: int64
          default: 0
        limit:
          type:
          - string
          - 'null'
          default: ''
        verbosity:
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
          - 5
          type: integer
          description: '* `0` - 0 (Normal)

            * `1` - 1 (Verbose)

            * `2` - 2 (More Verbose)

            * `3` - 3 (Debug)

            * `4` - 4 (Connection Debug)

            * `5` - 5 (WinRM Debug)'
          x-spec-enum-id: 8cfb81af905b865a
          default: 0
          minimum: 0
          maximum: 9223372036854775807
        extra_vars:
          type:
          - string
          - 'null'
          default: ''
        job_tags:
          type:
          - string
          - 'null'
          default: ''
        force_handlers:
          type:
          - boolean
          - 'null'
          default: false
        skip_tags:
          type:
          - string
          - 'null'
          default: ''
        start_at_task:
          type:
          - string
          - 'null'
          default: ''
          maxLength: 1024
        timeout:
          type: integer
          maximum: 9223372036854775807
          minimum: -9223372036854775808
          format: int64
          default: 0
          description: The amount of time (in seconds) to run before the task is canceled.
        use_fact_cache:
          type:
          - boolean
          - 'null'
          default: false
          description: If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible.
        execution_environment:
          type:
          - integer
          - 'null'
          description: The container image to be used for execution.
        host_config_key:
          type:
          - string
          - 'null'
          default: ''
          maxLength: 1024
        ask_scm_branch_on_launch:
          type:
          - boolean
          - 'null'
          default: false
        ask_diff_mode_on_launch:
          type:
          - boolean
          - 'null'
          default: false
        ask_variables_on_launch:
          type:
          - boolean
          - 'null'
          default: false
        ask_limit_on_launch:
          type:
          - boolean
          - 'null'
          default: false
        ask_tags_on_launch:
          type:
          - boolean
          - 'null'
          default: false
        ask_skip_tags_on_launch:
          type:
          - boolean
          - 'null'
          default: false
        ask_job_type_on_launch:
          type:
          - boolean
          - 'null'
          default: false
        ask_verbosity_on_launch:
          type:
          - boolean
          - 'null'
          default: false
        ask_inventory_on_launch:
          type:
          - boolean
          - 'null'
          default: false
        ask_credential_on_launch:
          type:
          - boolean
          - 'null'
          default: false
        ask_execution_environment_on_launch:
          type:
          - boolean
          - 'null'
          default: false
        ask_labels_on_launch:
          type:
          - boolean
          - 'null'
          default: false
        ask_forks_on_launch:
          type:
          - boolean
          - 'null'
          default: false
        ask_job_slice_count_on_launch:
          type:
          - boolean
          - 'null'
          default: false
        ask_timeout_on_launch:
          type:
          - boolean
          - 'null'
          default: false
        ask_instance_groups_on_launch:
          type:
          - boolean
          - 'null'
          default: false
        survey_enabled:
          type:
          - boolean
          - 'null'
          default: false
        become_enabled:
          type:
          - boolean
          - 'null'
          default: false
        diff_mode:
          type:
          - boolean
          - 'null'
          default: false
          description: If enabled, textual changes made to any templated files on the host are shown in the standard output
        allow_simultaneous:
          type:
          - boolean
          - 'null'
          default: false
        job_slice_count:
          type: integer
          maximum: 9223372036854775807
          minimum: 0
          format: int64
          default: 1
          description: The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1.
        webhook_service:
          enum:
          - github
          - gitlab
          - bitbucket_dc
          - ''
          - null
          type:
          - string
          - 'null'
          x-spec-enum-id: eee3a42406ba2781
          description: 'Service that webhook requests will be accepted from


            * `github` - GitHub

            * `gitlab` - GitLab

            * `bitbucket_dc` - BitBucket DataCenter'
        webhook_credential:
          type:
          - integer
          - 'null'
          description: Personal Access Token for posting back the status to the service API
        prevent_instance_group_fallback:
          type:
          - boolean
          - 'null'
          default: false
          description: If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied.
        opa_query_path:
          type:
          - string
          - 'null'
          description: The query path for the OPA policy to evaluate prior to job execution. The query path should be formatted as package/rule.
          maxLength: 128
      required:
      - name
    PatchedJobTemplateRequest:
      type: object
      description: Provide recent jobs and survey details in summary_fields
      properties:
        name:
          type:
          - string
          - 'null'
          minLength: 1
          maxLength: 512
        description:
          type:
          - string
          - 'null'
          default: ''
        job_type:
          enum:
          - run
          - check
          - null
          type:
          - string
          - 'null'
          description: '* `run` - Run

            * `check` - Check'
          x-spec-enum-id: 726608a431c1f104
          default: run
        inventory:
          type:
          - integer
          - 'null'
        project:
          type:
          - integer
          - 'null'
        playbook:
          type:
          - string
          - 'null'
          default: ''
          maxLength: 1024
        scm_branch:
          type:
          - string
          - 'null'
          default: ''
          description: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true.
          maxLength: 1024
        forks:
          type: integer
          maximum: 9223372036854775807
          minimum: 0
          format: int64
          default: 0
        limit:
          type:
          - string
          - 'null'
          default: ''
        verbosity:
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
          - 5
          type: integer
          description: '* `0` - 0 (Normal)

            * `1` - 1 (Verbose)

            * `2` - 2 (More Verbose)

            * `3` - 3 (Debug)

            * `4` - 4 (Connection Debug)

            * `5` - 5 (WinRM Debug)'
          x-spec-enum-id: 8cfb81af905b865a
          default: 0
          minimum: 0
          maximum: 9223372036854775807
        extra_vars:
          type:
          - string
          - 'null'
          default: ''
        job_tags:
          type:
          - string
          - 'null'
          default: ''
        force_handlers:
          type:
          - boolean
          - 'null'
          default: false
        skip_tags:
          type:
          - string
          - 'null'
          default: ''
        start_at_task:
          type:
          - string
          - 'null'
          default: ''
          maxLength: 1024
        timeout:
          type: integer
          maximum: 9223372036854775807
          minimum: -9223372036854775808
          format: int64
          default: 0
          description: The amount of time (in seconds) to run before the task is canceled.
        use_fact_cache:
          type:
          - boolean
          - 'null'
          default: false
          description: If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible.
        execution_environment:
          type:
          - integer
          - 'null'
          description: The container image to be used for execution.
        host_config_key:
          type:
          - string
          - 'null'
          default: ''
          maxLength: 1024
        ask_scm_branch_on_launch:
          type:
          - boolean
          - 'null'
          default: false
        ask_diff_mode_on_launch:
          type:
          - boolean
          - 'null'
          default: false
        ask_variables_on_launch:
          type:
          - boolean
          - 'null'
          default: false
        ask_limit_on_launch:
          type:
          - boolean
          - 'null'
          default: false
        ask_tags_on_launch:
          type:
          - boolean
          - 'null'
          default: false
        ask_skip_tags_on_launch:
          type:
          - boolean
          - 'null'
          default: false
        ask_job_type_on_launch:
          type:
          - boolean
          - 'null'
          default: false
        ask_verbosity_on_launch:
          type:
          - boolean
          - 'null'
          default: false
        ask_inventory_on_launch:
          type:
          - boolean
          - 'null'
          default: false
        ask_credential_on_launch:
          type:
          - boolean
          - 'null'
          default: false
        ask_execution_environment_on_launch:
          type:
          - boolean
          - 'null'
          default: false
        ask_labels_on_launch:
          type:
          - boolean
          - 'null'
          default: false
        ask_forks_on_launch:
          type:
          - boolean
          - 'null'
          default: false
        ask_job_slice_count_on_launch:
          type:
          - boolean
          - 'null'
          default: false
        ask_timeout_on_launch:
          type:
          - boolean
          - 'null'
          default: false
        ask_instance_groups_on_launch:
          type:
          - boolean
          - 'null'
          default: false
        survey_enabled:
          type:
          - boolean
          - 'null'
          default: false
        become_enabled:
          type:
          - boolean
          - 'null'
          default: false
        diff_mode:
          type:
          - boolean
          - 'null'
          default: false
          description: If enabled, textual changes made to any templated files on the host are shown in the standard output
        allow_simultaneous:
          type:
          - boolean
          - 'null'
          default: false
        job_slice_count:
          type: integer
          maximum: 9223372036854775807
          minimum: 0
          format: int64
          default: 1
          description: The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1.
        webhook_service:
          enum:
          - github
          - gitlab
          - bitbucket_dc
          - ''
          - null
          type:
          - string
          - 'null'
          x-spec-enum-id: eee3a42406ba2781
          description: 'Service that webhook requests will be accepted from


            * `github` - GitHub

            * `gitlab` - GitLab

            * `bitbucket_dc` - BitBucket DataCenter'
        webhook_credential:
          type:
          - integer
          - 'null'
          description: Personal Access Token for posting back the status to the service API
        prevent_instance_group_fallback:
          type:
          - boolean
          - 'null'
          default: false
          description: If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied.
        opa_query_path:
          type:
          - string
          - 'null'
          description: The query path for the OPA policy to evaluate prior to job execution. The query path should be formatted as package/rule.
          maxLength: 128
    ScheduleRequest:
      type: object
      properties:
        rrule:
          type:
          - string
          - 'null'
          minLength: 1
          description: A value representing the schedules iCal recurrence rule.
        name:
          type:
          - string
          - 'null'
          minLength: 1
          maxLength: 512
        description:
          type:
          - string
          - 'null'
          default: ''
        extra_data:
          default: {}
        inventory:
          type:
          - integer
          - 'null'
          description: Inventory applied as a prompt, assuming job template prompts for inventory
        scm_branch:
          type:
          - string
          - 'null'
        job_type:
          enum:
          - run
          - check
          - ''
          - null
          type:
          - string
          - 'null'
          description: '* `run` - Run

            * `check` - Check'
          x-spec-enum-id: 726608a431c1f104
        job_tags:
          type:
          - string
          - 'null'
        skip_tags:
          type:
          - string
          - 'null'
        limit:
          type:
          - string
          - 'null'
        diff_mode:
          type:
          - boolean
          - 'null'
        verbosity:
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
          - 5
          - null
          type:
          - integer
          - 'null'
          description: '* `0` - 0 (Normal)

            * `1` - 1 (Verbose)

            * `2` - 2 (More Verbose)

            * `3` - 3 (Debug)

            * `4` - 4 (Connection Debug)

            * `5` - 5 (WinRM Debug)'
          x-spec-enum-id: 8cfb81af905b865a
        execution_environment:
          type:
          - integer
          - 'null'
          description: The container image to be used for execution.
        forks:
          type:
          - integer
          - 'null'
          minimum: 0
        job_slice_count:
          type:
          - integer
          - 'null'
          minimum: 0
        timeout:
          type:
          - integer
          - 'null'
        unified_job_template:
          type: integer
        enabled:
          type:
          - boolean
          - 'null'
          default: true
          description: Enables processing of this schedule.
      required:
      - name
      - rrule
      - unified_job_template
    NotificationTemplateRequest:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          minLength: 1
          maxLength: 512
        description:
          type:
          - string
          - 'null'
          default: ''
        organization:
          type:
          - integer
          - 'null'
        notification_type:
          enum:
          - awssns
          - email
          - grafana
          - irc
          - mattermost
          - pagerduty
          - rocketchat
          - slack
          - twilio
          - webhook
          - null
          type:
          - string
          - 'null'
          description: '* `awssns` - AWS SNS

            * `email` - Email

            * `grafana` - Grafana

            * `irc` - IRC

            * `mattermost` - Mattermost

            * `pagerduty` - Pagerduty

            * `rocketchat` - Rocket.Chat

            * `slack` - Slack

            * `twilio` - Twilio

            * `webhook` - Webhook'
          x-spec-enum-id: 867d131dea32a033
        notification_configuration:
          default: {}
        messages:
          default:
            started: null
            success: null
            error: null
            workflow_approval: null
          description: Optional custom messages for notification template.
      required:
      - name
      - notification_type
      - organization
    JobList:
      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: ''
        unified_job_template:
          type:
          - integer
          - 'null'
          readOnly: true
        launch_type:
          enum:
          - manual
          - relaunch
          - callback
          - scheduled
          - dependency
          - workflow
          - webhook
          - sync
          - scm
          type: string
          description: '* `manual` - Manual

            * `relaunch` - Relaunch

            * `callback` - Callback

            * `scheduled` - Scheduled

            * `dependency` - Dependency

            * `workflow` - Workflow

            * `webhook` - Webhook

            * `sync` - Sync

            * `scm` - SCM Update'
          x-spec-enum-id: e5bed25c2e652da3
          readOnly: true
        status:
          enum:
          - new
          - pending
          - waiting
          - running
          - successful
          - failed
          - error
          - canceled
          type: string
          description: '* `new` - New

            * `pending` - Pending

            * `waiting` - Waiting

            * `running` - Running

            * `successful` - Successful

            * `failed` - Failed

            * `error` - Error

            * `canceled` - Canceled'
          x-spec-enum-id: 6021859c28387823
          readOnly: true
        execution_environment:
          type:
          - integer
          - 'null'
          description: The container image to be used for execution.
        failed:
          type: boolean
          readOnly: true
        started:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
          description: The date and time the job was queued for starting.
        finished:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
          description: The date and time the job finished execution.
        canceled_on:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
          description: The date and time when the cancel request was sent.
        elapsed:
          type: string
          format: decimal
          pattern: ^-?\d{0,9}(?:\.\d{0,3})?$
          readOnly: true
          description: Elapsed time in seconds that the job ran.
        job_explanation:
          type: string
          readOnly: true
          description: A status field to indicate the state of the job if it wasn't able to run and capture stdout
        execution_node:
          type: string
          readOnly: true
          description: The node the job executed on.
        controller_node:
          type: string
          readOnly: true
          description: The instance that managed the execution environment.
        launched_by:
          type: string
          readOnly: true
        work_unit_id:
          type:
          - string
          - 'null'
          readOnly: true
          description: The Receptor work unit ID associated with this job.
        job_type:
          enum:
          - run
          - check
          - scan
          - null
          type:
          - string
          - 'null'
          description: '* `run` - Run

            * `check` - Check

            * `scan` - Scan'
          x-spec-enum-id: b0ae05beb5a5e8ab
          default: run
        inventory:
          type:
          - integer
          - 'null'
        project:
          type:
          - integer
          - 'null'
        playbook:
          type:
          - string
          - 'null'
          default: ''
          maxLength: 1024
        scm_branch:
          type:
          - string
          - 'null'
          default: ''
          description: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true.
          maxLength: 1024
        forks:
          type: integer
          maximum: 9223372036854775807
          minimum: 0
          format: int64
          default: 0
        limit:
          type:
          - string
          - 'null'
          default: ''
        verbosity:
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
          - 5
          type: integer
          description: '* `0` - 0 (Normal)

            * `1` - 1 (Verbose)

            * `2` - 2 (More Verbose)

            * `3` - 3 (Debug)

            * `4` - 4 (Connection Debug)

            * `5` - 5 (WinRM Debug)'
          x-spec-enum-id: 8cfb81af905b865a
          default: 0
          minimum: 0
          maximum: 9223372036854775807
        extra_vars:
          type:
          - string
          - 'null'
          default: ''
        job_tags:
          type:
          - string
          - 'null'
          default: ''
        force_handlers:
          type:
          - boolean
          - 'null'
          default: false
        skip_tags:
          type:
          - string
          - 'null'
          default: ''
        start_at_task:
          type:
          - string
          - 'null'
          default: ''
          maxLength: 1024
        timeout:
          type: integer
          maximum: 9223372036854775807
          minimum: -9223372036854775808
          format: int64
          default: 0
          description: The amount of time (in seconds) to run before the task is canceled.
        use_fact_cache:
          type:
          - boolean
          - 'null'
          default: false
          description: If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible.
        organization:
          type:
          - integer
          - 'null'
          readOnly: true
          description: The organization used to determine access to this unified job.
        job_template:
          type:
          - integer
          - 'null'
        passwords_needed_to_start:
          type: string
          readOnly: true
        allow_simultaneous:
          type:
          - boolean
          - 'null'
          default: false
        artifacts:
          type: string
          readOnly: true
        scm_revision:
          type: string
          readOnly: true
          description: The SCM Revision from the Project used for this job, if available
        instance_group:
          type:
          - integer
          - 'null'
          description: The Instance group the job was run under
        diff_mode:
          type:
          - boolean
          - 'null'
          default: false
          description: If enabled, textual changes made to any templated files on the host are shown in the standard output
        job_slice_number:
          type: integer
          maximum: 9223372036854775807
          minimum: 0
          format: int64
          default: 0
          description: If part of a sliced job, the ID of the inventory slice operated on. If not part of sliced job, parameter is not used.
        job_slice_count:
          type: integer
          maximum: 9223372036854775807
          minimum: 0
          format: int64
          default: 1
          description: If ran as part of sliced jobs, the total number of slices. If 1, job is not part of a sliced job.
        webhook_service:
          enum:
          - github
          - gitlab
          - bitbucket_dc
          - ''
          - null
          type:
          - string
          - 'null'
          x-spec-enum-id: eee3a42406ba2781
          description: 'Service that webhook requests will be accepted from


            * `github` - GitHub

            * `gitlab` - GitLab

            * `bitbucket_dc` - BitBucket DataCenter'
        webhook_credential:
          type:
          - integer
          - 'null'
          description: Personal Access Token for posting back the status to the service API
        webhook_guid:
          type:
          - string
          - 'null'
          description: Unique identifier of the event that triggered this webhook
          maxLength: 128
      required:
      - name
    PaginatedResourceAccessListElementList:
      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/ResourceAccessListElement'
    PaginatedNotificationTemplateList:
      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/NotificationTemplate'
    WorkflowJobList:
      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: ''
        unified_job_template:
          type:
          - integer
          - 'null'
          readOnly: true
        launch_type:
          enum:
          - manual
          - relaunch
          - callback
          - scheduled
          - dependency
          - workflow
          - webhook
          - sync
          - scm
          type: string
          description: '* `manual` - Manual

            * `relaunch` - Relaunch

            * `callback` - Callback

            * `scheduled` - Scheduled

            * `dependency` - Dependency

            * `workflow` - Workflow

            * `webhook` - Webhook

            * `sync` - Sync

            * `scm` - SCM Update'
          x-spec-enum-id: e5bed25c2e652da3
          readOnly: true
        status:
          enum:
          - new
          - pending
          - waiting
          - running
          - successful
          - failed
          - error
          - canceled
          type: string
          description: '* `new` - New

            * `pending` - Pending

            * `waiting` - Waiting

            * `running` - Running

            * `successful` - Successful

            * `failed` - Failed

            * `error` - Error

            * `canceled` - Canceled'
          x-spec-enum-id: 6021859c28387823
          readOnly: true
        failed:
          type: boolean
          readOnly: true
        started:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
          description: The date and time the job was queued for starting.
        finished:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
          description: The date and time the job finished execution.
        canceled_on:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
          description: The date and time when the cancel request was sent.
        elapsed:
          type: string
          format: decimal
          pattern: ^-?\d{0,9}(?:\.\d{0,3})?$
          readOnly: true
          description: Elapsed time in seconds that the job ran.
        job_explanation:
          type: string
          readOnly: true
          description: A status field to indicate the state of the job if it wasn't able to run and capture stdout
        launched_by:
          type: string
          readOnly: true
        work_unit_id:
          type:
          - string
          - 'null'
          readOnly: true
          description: The Receptor work unit ID associated with this job.
        workflow_job_template:
          type:
          - integer
          - 'null'
        extra_vars:
          type:
          - string
          - 'null'
          default: ''
        allow_simultaneous:
          type:
          - boolean
          - 'null'
          default: false
        job_template:
          type:
          - integer
          - 'null'
          description: If automatically created for a sliced job run, the job template the workflow job was created from.
        is_sliced_job:
          type:
          - boolean
          - 'null'
          default: false
        inventory:
          type:
          - integer
          - 'null'
          description: Inventory applied as a prompt, assuming job template prompts for inventory
        limit:
          type:
          - string
          - 'null'
        scm_branch:
          type:
          - string
          - 'null'
        webhook_service:
          enum:
          - github
          - gitlab
          - bitbucket_dc
          - ''
          - null
          type:
          - string
          - 'null'
          x-spec-enum-id: eee3a42406ba2781
          description: 'Service that webhook requests will be accepted from


            * `github` - GitHub

            * `gitlab` - GitLab

            * `bitbucket_dc` - BitBucket DataCenter'
        webhook_credential:
          type:
          - integer
          - 'null'
          description: Personal Access Token for posting back the status to the service API
        webhook_guid:
          type:
          - string
          - 'null'
          description: Unique identifier of the event that triggered this webhook
          maxLength: 128
        skip_tags:
          type:
          - string
          - 'null'
        job_tags:
          type:
          - string
          - 'null'
      required:
      - name
    JobLaunchRequest:
      type: object
      properties:
        extra_vars:
          writeOnly: true
        inventory:
          type: integer
          writeOnly: true
        scm_branch:
          type: string
          writeOnly: true
        limit:
          type: string
          writeOnly: true
        job_tags:
          type: string
          writeOnly: true
        skip_tags:
          type: string
          writeOnly: true
        job_type:
          enum:
          - run
          - check
          type: string
          description: '* `run` - Run

            * `check` - Check'
          x-spec-enum-id: 726608a431c1f104
          writeOnly: true
        verbosity:
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
          - 5
          type: integer
          description: '* `0` - 0 (Normal)

            * `1` - 1 (Verbose)

            * `2` - 2 (More Verbose)

            * `3` - 3 (Debug)

            * `4` - 4 (Connection Debug)

            * `5` - 5 (WinRM Debug)'
          x-spec-enum-id: 8cfb81af905b865a
          writeOnly: true
        diff_mode:
          type: boolean
          writeOnly: true
        credentials:
          type: array
          items:
            type: integer
            writeOnly: true
          writeOnly: true
        credential_passwords:
          type: string
          writeOnly: true
        execution_environment:
          type: integer
          writeOnly: true
        labels:
          type: array
          items:
            type: integer
            writeOnly: true
          writeOnly: true
        forks:
          type: integer
          minimum: 0
          writeOnly: true
        job_slice_count:
          type: integer
          minimum: 0
          writeOnly: true
        timeout:
          type: integer
          writeOnly: true
        instance_groups:
          type: array
          items:
            type: integer
            writeOnly: true
          writeOnly: true
    PaginatedJobListList:
      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/JobList'
    JobTemplate:
      type: object
      description: Provide recent jobs and survey details in summary_fields
      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: ''
        job_type:
          enum:
          - run
          - check
          - null
          type:
          - string
          - 'null'
          description: '* `run` - Run

            * `check` - Check'
          x-spec-enum-id: 726608a431c1f104
          default: run
        inventory:
          type:
          - integer
          - 'null'
        project:
          type:
          - integer
          - 'null'
        playbook:
          type:
          - string
          - 'null'
          default: ''
          maxLength: 1024
        scm_branch:
          type:
          - string
          - 'null'
          default: ''
          description: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true.
          maxLength: 1024
        forks:
          type: integer
          maximum: 9223372036854775807
          minimum: 0
          format: int64
          default: 0
        limit:
          type:
          - string
          - 'null'
          default: ''
        verbosity:
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
          - 5
          type: integer
          description: '* `0` - 0 (Normal)

            * `1` - 1 (Verbose)

            * `2` - 2 (More Verbose)

            * `3` - 3 (Debug)

            * `4` - 4 (Connection Debug)

            * `5` - 5 (WinRM Debug)'
          x-spec-enum-id: 8cfb81af905b865a
          default: 0
          minimum: 0
          maximum: 9223372036854775807
        extra_vars:
          type:
          - string
          - 'null'
          default: ''
        job_tags:
          type:
          - string
          - 'null'
          default: ''
        force_handlers:
          type:
          - boolean
          - 'null'
          default: false
        skip_tags:
          type:
          - string
          - 'null'
          default: ''
        start_at_task:
          type:
          - string
          - 'null'
          default: ''
          maxLength: 1024
        timeout:
          type: integer
          maximum: 9223372036854775807
          minimum: -9223372036854775808
          format: int64
          default: 0
          description: The amount of time (in seconds) to run before the task is canceled.
        use_fact_cache:
          type:
          - boolean
          - 'null'
          default: false
          description: If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible.
        organization:
          type:
          - integer
          - 'null'
          readOnly: true
          description: The organization used to determine access to this template.
        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
          type: string
          description: '* `new` - New

            * `pending` - Pending

            * `waiting` - Waiting

            * `running` - Running

            * `successful` - Successful

            * `failed` - Failed

            * `error` - Error

            * `canceled` - Canceled

            * `never updated` - Never Updated'
          x-spec-enum-id: 91b42427ee973322
          readOnly: true
        execution_environment:
          type:
          - integer
          - 'null'
          description: The container image to be used for execution.
        host_config_key:
          type:
          - string
          - 'null'
          default: ''
          maxLength: 1024
        ask_scm_branch_on_launch:
          type:
          - boolean
          - 'null'
          default: false
        ask_diff_mode_on_launch:
          type:
          - boolean
          - 'null'
          default: false
        ask_variables_on_launch:
          type:
          - boolean
          - 'null'
          default: false
        ask_limit_on_launch:
          type:
          - boolean
          - 'null'
          default: false
        ask_tags_on_launch:
          type:
          - boolean
          - 'null'
          default: false
        ask_skip_tags_on_launch:
          type:
          - boolean
          - 'null'
          default: false
        ask_job_type_on_launch:
          type:
          - boolean
          - 'null'
          default: false
        ask_verbosity_on_launch:
          type:
          - boolean
          - 'null'
          default: false
        ask_inventory_on_launch:
          type:
          - boolean
          - 'null'
          default: false
        ask_credential_on_launch:
          type:
          - boolean
          - 'null'
          default: false
        ask_execution_environment_on_launch:
          type:
          - boolean
          - 'null'
          default: false
        ask_labels_on_launch:
          type:
          - boolean
          - 'null'
          default: false
        ask_forks_on_launch:
          type:
          - boolean
          - 'null'
          default: false
        ask_job_slice_count_on_launch:
          type:
          - boolean
          - 'null'
          default: false
        ask_timeout_on_launch:
          type:
          - boolean
          - 'null'
          default: false
        ask_instance_groups_on_launch:
          type:
          - boolean
          - 'null'
          default: false
        survey_enabled:
          type:
          - boolean
          - 'null'
          default: false
        become_enabled:
          type:
          - boolean
          - 'null'
          default: false
        diff_mode:
          type:
          - boolean
          - 'null'
          default: false
          description: If enabled, textual changes made to any templated files on the host are shown in the standard output
        allow_simultaneous:
          type:
          - boolean
          - 'null'
          default: false
        custom_virtualenv:
          type:
          - string
          - 'null'
          readOnly: true
          description: Local absolute file path containing a custom Python virtualenv to use
        job_slice_count:
          type: integer
          maximum: 9223372036854775807
          minimum: 0
          format: int64
          default: 1
          description: The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1.
        webhook_service:
          enum:
          - github
          - gitlab
          - bitbucket_dc
          - ''
          - null
          type:
          - string
          - 'null'
          x-spec-enum-id: eee3a42406ba2781
          description: 'Service that webhook requests will be accepted from


            * `github` - GitHub

            * `gitlab` - GitLab

            * `bitbucket_dc` - BitBucket DataCenter'
        webhook_credential:
          type:
          - integer
          - 'null'
          description: Personal Access Token for posting back the status to the service API
        prevent_instance_group_fallback:
          type:
          - boolean
          - 'null'
          default: false
          description: If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied.
        opa_query_path:
          type:
          - string
          - 'null'
          description: The query path for the OPA policy to evaluate prior to job execution. The query path should be formatted as package/rule.
          maxLength: 128
      required:
      - name
    PaginatedRoleList:
      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/Role'
    ActivityStream:
      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
        timestamp:
          type: string
          format: date-time
          readOnly: true
        operation:
          enum:
          - create
          - update
          - delete
          - associate
          - disassociate
          - null
          type:
          - string
          - 'null'
          x-spec-enum-id: d1cf1307b8aa394e
          description: 'The action taken with respect to the given object(s).


            * `create` - Entity Created

            * `update` - Entity Updated

            * `delete` - Entity Deleted

            * `associate` - Entity Associated with another Entity

            * `disassociate` - Entity was Disassociated with another Entity'
        changes:
          type: string
          readOnly: true
          description: A summary of the new and changed values when an object is created, updated, or deleted
        object1:
          type:
          - string
          - 'null'
          description: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2.
        object2:
          type:
          - string
          - 'null'
          description: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with.
        object_association:
          type: string
          readOnly: true
          description: When present, shows the field name of the role or relationship that changed.
        action_node:
          type: string
          readOnly: true
          description: The cluster node the activity took place on.
        object_type:
          type: string
          readOnly: true
          description: When present, shows the model on which the role or relationship was defined.
      required:
      - object1
      - object2
      - operation
    NotificationTemplate:
      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: ''
        organization:
          type:
          - integer
          - 'null'
        notification_type:
          enum:
          - awssns
          - email
          - grafana
          - irc
          - mattermost
          - pagerduty
          - rocketchat
          - slack
          - twilio
          - webhook
          - null
          type:
          - string
          - 'null'
          description: '* `awssns` - AWS SNS

            * `email` - Email

            * `grafana` - Grafana

            * `irc` - IRC

            * `mattermost` - Mattermost

            * `pagerduty` - Pagerduty

            * `rocketchat` - Rocket.Chat

            * `slack` - Slack

            * `twilio` - Twilio

            * `webhook` - Webhook'
          x-spec-enum-id: 867d131dea32a033
        notification_configuration:
          default: {}
        messages:
          default:
            started: null
            success: null
            error: null
            workflow_approval: null
          description: Optional custom messages for notification template.
      required:
      - name
      - notification_type
      - organization
    ResourceAccessListElement:
      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
        username:
          type:
          - string
          - 'null'
          description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
          pattern: ^[\w.@+-]+$
          maxLength: 150
        first_name:
          type:
          - string
          - 'null'
          maxLength: 150
        last_name:
          type:
          - string
          - 'null'
          maxLength: 150
        email:
          type:
          - string
          - 'null'
          title: Email address
          maxLength: 254
        is_superuser:
          type:
          - boolean
          - 'null'
          default: false
          title: Superuser status
          description: Designates that this user has all permissions without explicitly assigning them.
        is_system_auditor:
          type: boolean
          default: false
        password:
          type: string
          default: ''
          description: Field used to change the password.
        last_login:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
      required:
      - username
    LabelRequest:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          minLength: 1
          maxLength: 512
        organization:
          type: integer
          description: Organization this label belongs to.
      required:
      - name
      - organization
    JobLaunch:
      type: object
      properties:
        can_start_without_user_input:
          type: boolean
          readOnly: true
        passwords_needed_to_start:
          type: string
          readOnly: true
        ask_scm_branch_on_launch:
          type:
          - boolean
          - 'null'
          readOnly: true
        ask_variables_on_launch:
          type:
          - boolean
          - 'null'
          readOnly: true
        ask_tags_on_launch:
          type:
          - boolean
          - 'null'
          readOnly: true
        ask_diff_mode_on_launch:
          type:
          - boolean
          - 'null'
          readOnly: true
        ask_skip_tags_on_launch:
          type:
          - boolean
          - 'null'
          readOnly: true
        ask_job_type_on_launch:
          type:
          - boolean
          - 'null'
          readOnly: true
        ask_limit_on_launch:
          type:
          - boolean
          - 'null'
          readOnly: true
        ask_verbosity_on_launch:
          type:
          - boolean
          - 'null'
          readOnly: true
        ask_inventory_on_launch:
          type:
          - boolean
          - 'null'
          readOnly: true
        ask_credential_on_launch:
          type:
          - boolean
          - 'null'
          readOnly: true
        ask_execution_environment_on_launch:
          type:
          - boolean
          - 'null'
          readOnly: true
        ask_labels_on_launch:
          type:
          - boolean
          - 'null'
          readOnly: true
        ask_forks_on_launch:
          type:
          - boolean
          - 'null'
          readOnly: true
        ask_job_slice_count_on_launch:
          type:
          - boolean
          - 'null'
          readOnly: true
        ask_timeout_on_launch:
          type:
          - boolean
          - 'null'
          readOnly: true
        ask_instance_groups_on_launch:
          type:
          - boolean
          - 'null'
          readOnly: true
        survey_enabled:
          type: string
          readOnly: true
        variables_needed_to_start:
          type: string
          readOnly: true
        credential_needed_to_start:
          type: string
          readOnly: true
        inventory_needed_to_start:
          type: string
          readOnly: true
        job_template_data:
          type: string
          readOnly: true
        defaults:
          type: string
          readOnly: true
    PaginatedWorkflowJobListList:
      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/WorkflowJobList'
    Label:
      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
        organization:
          type: integer
          description: Organization this label belongs to.
      required:
      - name
      - organization
    PaginatedInstanceGroupList:
      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/InstanceGroup'
    InstanceGroup:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        type:
          type: string
          readOnly: true
        url:
          type: string
          readOnly: true
        related:
          type: string
          readOnly: true
        name:
          type:
          - string
          - 'null'
          maxLength: 250
        created:
          type: string
          readOnly: true
        modified:
          type: string
          readOnly: true
        capacity:
          type: string
          readOnly: true
        consumed_capacity:
          type: string
          readOnly: true
        percent_capacity_remaining:
          type: string
          readOnly: true
        jobs_running:
          type: string
          readOnly: true
        max_concurrent_jobs:
          type: integer
          minimum: 0
          default: 0
          description: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced.
        max_forks:
          type: integer
          minimum: 0
          default: 0
          description: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced.
        jobs_total:
          type: integer
          readOnly: true
          description: Count of all jobs that target this instance group
        instances:
          type: string
          readOnly: true
        is_container_group:
          type: boolean
          description: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster.
        credential:
          type:
          - integer
          - 'null'
        policy_instance_percentage:
          type: integer
          maximum: 100
          minimum: 0
          default: 0
          description: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online.
        policy_instance_minimum:
          type: integer
          minimum: 0
          default: 0
          description: Static minimum number of Instances that will be automatically assign to this group when new instances come online.
        policy_instance_list:
          type: array
          items:
            type: string
          description: List of exact-match Instances that will be assigned to this group
        pod_spec_override:
          type:
          - string
          - 'null'
          default: ''
        summary_fields:
          type: string
          readOnly: true
      required:
      - name
    Credential:
      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: ''
        organization:
          type:
          - integer
          - 'null'
        credential_type:
          type: integer
          description: Specify the type of credential you want to create. Refer to the documentation for details on each type.
        managed:
          type: boolean
          readOnly: true
        inputs:
          default: {}
          description: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax.
        kind:
          type: string
          readOnly: true
        cloud:
          type: string
          readOnly: true
        kubernetes:
          type: string
          readOnly: true
      required:
      - credential_type
      - name
    PaginatedScheduleList:
      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/Schedule'
    Copy:
      type: object
      properties:
        name:
          type: string
      required:
      - name
    Schedule:
      type: object
      properties:
        rrule:
          type:
          - string
          - 'null'
          description: A value representing the schedules iCal recurrence rule.
        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: ''
        extra_data:
          default: {}
        inventory:
          type:
          - integer
          - 'null'
          description: Inventory applied as a prompt, assuming job template prompts for inventory
        scm_branch:
          type:
          - string
          - 'null'
        job_type:
          enum:
          - run
          - check
          - ''
          - null
          type:
          - string
          - 'null'
          description: '* `run` - Run

            * `check` - Check'
          x-spec-enum-id: 726608a431c1f104
        job_tags:
          type:
          - string
          - 'null'
        skip_tags:
          type:
          - string
          - 'null'
        limit:
          type:
          - string
          - 'null'
        diff_mode:
          type:
          - boolean
          - 'null'
        verbosity:
          enum:
          - 0
          - 1
          - 2
          - 3
          - 4
          - 5
          - null
          type:
          - integer
          - 'null'
          description: '* `0` - 0 (Normal)

            * `1` - 1 (Verbose)

            * `2` - 2 (More Verbose)

            * `3` - 3 (Debug)

            * `4` - 4 (Connection Debug)

            * `5` - 5 (WinRM Debug)'
          x-spec-enum-id: 8cfb81af905b865a
        execution_environment:
          type:
          - integer
          - 'null'
          description: The container image to be used for execution.
        forks:
          type:
          - integer
          - 'null'
          minimum: 0
        job_slice_count:
          type:
          - integer
          - 'null'
          minimum: 0
        timeout:
          type:
          - integer
          - 'null'
        unified_job_template:
          type: integer
        enabled:
          type:
          - boolean
          - 'null'
          default: true
          description: Enables processing of this schedule.
        dtstart:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
          description: The first occurrence of the schedule occurs on or after this time.
        dtend:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
          description: The last occurrence of the schedule occurs before this time, aftewards the schedule expires.
        next_run:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
          description: The next time that the scheduled action will run.
        timezone:
          type: string
          readOnly: true
          description: The timezone this schedule runs in. This field is extracted from the RRULE. If the timezone in the RRULE is a link to another timezone, the link will be reflected in this field.
        until:
          type: string
          readOnly: true
          description: The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned
      required:
      - name
      - rrule
      - unified_job_template
    Role:
      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
        name:
          type: string
          readOnly: true
        description:
          type: string
          readOnly: true
    InstanceGroupRequest:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          minLength: 1
          maxLength: 250
        max_concurrent_jobs:
          type: integer
          minimum: 0
          default: 0
          description: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced.
        max_forks:
          type: integer
          minimum: 0
          default: 0
          description: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced.
        is_container_group:
          type: boolean
          description: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster.
        credential:
          type:
          - integer
          - 'null'
        policy_instance_percentage:
          type: integer
          maximum: 100
          minimum: 0
          default: 0
          description: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online.
        policy_instance_minimum:
          type: integer
          minimum: 0
          default: 0
          description: Static minimum number of Instances that will be automatically assign to this group when new instances come online.
        policy_instance_list:
          type: array
          items:
            type: string
            minLength: 1
          description: List of exact-match Instances that will be assigned to this group
        pod_spec_override:
          type:
          - string
          - 'null'
          default: ''
      required:
      - name
    PaginatedLabelList:
      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/Label'
    PaginatedJobTemplateList:
      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/JobTemplate'
    CredentialRequest:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          minLength: 1
          maxLength: 512
        description:
          type:
          - string
          - 'null'
          default: ''
        organization:
          type:
          - integer
          - 'null'
        credential_type:
          type: integer
          description: Specify the type of credential you want to create. Refer to the documentation for details on each type.
        inputs:
          default: {}
          description: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax.
      required:
      - credential_type
      - name
    WorkflowJobListRequest:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          minLength: 1
          maxLength: 512
        description:
          type:
          - string
          - 'null'
          default: ''
        workflow_job_template:
          type:
          - integer
          - 'null'
        extra_vars:
          type:
          - string
          - 'null'
          default: ''
        allow_simultaneous:
          type:
          - boolean
          - 'null'
          default: false
        job_template:
          type:
          - integer
          - 'null'
          description: If automatically created for a sliced job run, the job template the workflow job was created from.
        is_sliced_job:
          type:
          - boolean
          - 'null'
          default: false
        inventory:
          type:
          - integer
          - 'null'
          description: Inventory applied as a prompt, assuming job template prompts for inventory
        limit:
          type:
          - string
          - 'null'
        scm_branch:
          type:
          - string
          - 'null'
        webhook_service:
          enum:
          - github
          - gitlab
          - bitbucket_dc
          - ''
          - null
          type:
          - string
          - 'null'
          x-spec-enum-id: eee3a42406ba2781
          description: 'Service that webhook requests will be accepted from


            * `github` - GitHub

            * `gitlab` - GitLab

            * `bitbucket_dc` - BitBucket DataCenter'
        webhook_credential:
          type:
          - integer
          - 'null'
          description: Personal Access Token for posting back the status to the service API
        webhook_guid:
          type:
          - string
          - 'null'
          description: Unique identifier of the event that triggered this webhook
          maxLength: 128
        skip_tags:
          type:
          - string
          - 'null'
        job_tags:
          type:
          - string
          - 'null'
      required:
      - name
    PaginatedActivityStreamList:
      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/ActivityStream'