openapi: 3.2.0
info:
  title: AWX Inventory Updates API
  version: v2
  description: AWX API Documentation
  contact:
    email: ansible-community@redhat.com
  license:
    name: Apache License
tags:
- name: inventory_updates
paths:
  /api/v2/inventory_updates/:
    get:
      operationId: inventory_updates_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:
      - inventory_updates
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedInventoryUpdateListList'
          description: ''
      x-ai-description: List inventory updates
      summary: Inventory updates list
      x-summary-source: derived
  /api/v2/inventory_updates/{id}/:
    get:
      operationId: inventory_updates_retrieve
      description: Special handling when deleting a running unified job object.
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - inventory_updates
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InventoryUpdateDetail'
          description: ''
      x-ai-description: Retrieve an inventory update
      summary: Inventory updates retrieve
      x-summary-source: derived
    delete:
      operationId: inventory_updates_destroy
      description: Special handling when deleting a running unified job object.
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - inventory_updates
      responses:
        '204':
          description: No response body
      x-ai-description: Delete an inventory update
      summary: Inventory updates destroy
      x-summary-source: derived
  /api/v2/inventory_updates/{id}/cancel/:
    get:
      operationId: inventory_updates_cancel_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - inventory_updates
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InventoryUpdateCancel'
          description: ''
      x-ai-description: Retrieve a cancel for an inventory update
      summary: Inventory updates cancel retrieve
      x-summary-source: derived
    post:
      operationId: inventory_updates_cancel_create
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - inventory_updates
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InventoryUpdateCancel'
          description: ''
      x-ai-description: Create a cancel for an inventory update
      summary: Inventory updates cancel create
      x-summary-source: derived
  /api/v2/inventory_updates/{id}/credentials/:
    get:
      operationId: inventory_updates_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:
      - inventory_updates
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedCredentialList'
          description: ''
      x-ai-description: List credentials of an inventory update
      summary: Inventory updates credentials list
      x-summary-source: derived
  /api/v2/inventory_updates/{id}/events/:
    get:
      operationId: inventory_updates_events_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:
      - inventory_updates
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedInventoryUpdateEventList'
          description: ''
      x-ai-description: List events of an inventory update
      summary: Inventory updates events list
      x-summary-source: derived
  /api/v2/inventory_updates/{id}/notifications/:
    get:
      operationId: inventory_updates_notifications_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:
      - inventory_updates
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedNotificationList'
          description: ''
      x-ai-description: List notifications of an inventory update
      summary: Inventory updates notifications list
      x-summary-source: derived
  /api/v2/inventory_updates/{id}/stdout/:
    get:
      operationId: inventory_updates_stdout_retrieve
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - ansi
          - ansi_download
          - html
          - json
          - txt
          - txt_download
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - inventory_updates
      responses:
        '200':
          content:
            text/html:
              schema:
                $ref: '#/components/schemas/UnifiedJobStdout'
            text/plain:
              schema:
                $ref: '#/components/schemas/UnifiedJobStdout'
            application/json:
              schema:
                $ref: '#/components/schemas/UnifiedJobStdout'
          description: ''
      x-ai-description: Retrieve a stdout output of an inventory update
      summary: Inventory updates stdout retrieve
      x-summary-source: derived
components:
  schemas:
    InventoryUpdateCancel:
      type: object
      properties:
        can_cancel:
          type: boolean
          readOnly: true
    PaginatedNotificationList:
      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/Notification'
    PaginatedInventoryUpdateEventList:
      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/InventoryUpdateEvent'
    UnifiedJobStdout:
      type: object
      properties:
        result_stdout:
          type: string
          readOnly: true
    InventoryUpdateList:
      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.
        source:
          enum:
          - azure_rm
          - controller
          - ec2
          - gce
          - insights
          - openshift_virtualization
          - openstack
          - rhv
          - satellite6
          - terraform
          - vmware
          - scm
          - constructed
          type: string
          description: '* `azure_rm` - Microsoft Azure Resource Manager

            * `controller` - Red Hat Ansible Automation Platform

            * `ec2` - Amazon EC2

            * `gce` - Google Compute Engine

            * `insights` - Red Hat Insights

            * `openshift_virtualization` - OpenShift Virtualization

            * `openstack` - OpenStack

            * `rhv` - Red Hat Virtualization

            * `satellite6` - Red Hat Satellite 6

            * `terraform` - Terraform State

            * `vmware` - VMware vCenter

            * `scm` - Sourced from a Project

            * `constructed` - Template additional groups and hostvars at runtime'
          x-spec-enum-id: 2e54dfe09d4f7d8d
        source_path:
          type:
          - string
          - 'null'
          default: ''
          maxLength: 1024
        source_vars:
          type:
          - string
          - 'null'
          default: ''
          description: Inventory source variables in YAML or JSON format.
        scm_branch:
          type:
          - string
          - 'null'
          default: ''
          description: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true.
          maxLength: 1024
        credential:
          type:
          - integer
          - 'null'
          minimum: 1
          description: Cloud credential to use for inventory updates.
        enabled_var:
          type:
          - string
          - 'null'
          default: ''
          description: 'Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default)'
        enabled_value:
          type:
          - string
          - 'null'
          default: ''
          description: 'Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{   "status": {     "power_state": "powered_on",     "created": "2020-08-04T18:13:04+00:00",     "healthy": true    },    "name": "foobar",    "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled'
        host_filter:
          type:
          - string
          - 'null'
          default: ''
          description: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported.
        overwrite:
          type:
          - boolean
          - 'null'
          default: false
          description: Overwrite local groups and hosts from remote inventory source.
        overwrite_vars:
          type:
          - boolean
          - 'null'
          default: false
          description: Overwrite local variables from remote inventory source.
        custom_virtualenv:
          type:
          - string
          - 'null'
          description: Local absolute file path containing a custom Python virtualenv to use
          readOnly: true
        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.
        verbosity:
          enum:
          - 0
          - 1
          - 2
          type: integer
          description: '* `0` - 0 (WARNING)

            * `1` - 1 (INFO)

            * `2` - 2 (DEBUG)'
          x-spec-enum-id: 48197bd695a06691
          default: 1
          minimum: 0
          maximum: 9223372036854775807
        limit:
          type:
          - string
          - 'null'
          default: ''
          description: Enter host, group or pattern match
        inventory:
          type:
          - integer
          - 'null'
        inventory_source:
          type: integer
          readOnly: true
        license_error:
          type: boolean
          readOnly: true
        org_host_limit_error:
          type: boolean
          readOnly: true
        source_project_update:
          type:
          - integer
          - 'null'
          description: Inventory files from this Project Update were used for the inventory update.
        instance_group:
          type:
          - integer
          - 'null'
          description: The Instance group the job was run under
        scm_revision:
          type: string
          readOnly: true
          description: The SCM Revision from the Project used for this inventory update.  Only applicable to inventories source from scm
      required:
      - name
      - source
    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'
    PaginatedInventoryUpdateListList:
      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/InventoryUpdateList'
    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
    InventoryUpdateEvent:
      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
        event:
          type: string
          readOnly: true
        counter:
          type: integer
          minimum: 0
          readOnly: true
        event_display:
          type: string
          readOnly: true
        event_data:
          default: {}
        failed:
          type: string
          readOnly: true
        changed:
          type: string
          readOnly: true
        uuid:
          type: string
          readOnly: true
        stdout:
          type: string
          readOnly: true
        start_line:
          type: integer
          minimum: 0
          readOnly: true
        end_line:
          type: integer
          minimum: 0
          readOnly: true
        verbosity:
          type: integer
          minimum: 0
          readOnly: true
        inventory_update:
          type: integer
          readOnly: true
    InventoryUpdateDetail:
      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: ''
        source:
          enum:
          - azure_rm
          - controller
          - ec2
          - gce
          - insights
          - openshift_virtualization
          - openstack
          - rhv
          - satellite6
          - terraform
          - vmware
          - scm
          - constructed
          type: string
          description: '* `azure_rm` - Microsoft Azure Resource Manager

            * `controller` - Red Hat Ansible Automation Platform

            * `ec2` - Amazon EC2

            * `gce` - Google Compute Engine

            * `insights` - Red Hat Insights

            * `openshift_virtualization` - OpenShift Virtualization

            * `openstack` - OpenStack

            * `rhv` - Red Hat Virtualization

            * `satellite6` - Red Hat Satellite 6

            * `terraform` - Terraform State

            * `vmware` - VMware vCenter

            * `scm` - Sourced from a Project

            * `constructed` - Template additional groups and hostvars at runtime'
          x-spec-enum-id: 2e54dfe09d4f7d8d
        source_path:
          type:
          - string
          - 'null'
          default: ''
          maxLength: 1024
        source_vars:
          type:
          - string
          - 'null'
          default: ''
          description: Inventory source variables in YAML or JSON format.
        scm_branch:
          type:
          - string
          - 'null'
          default: ''
          description: Inventory source SCM branch. Project default used if blank. Only allowed if project allow_override field is set to true.
          maxLength: 1024
        credential:
          type:
          - integer
          - 'null'
          minimum: 1
          description: Cloud credential to use for inventory updates.
        enabled_var:
          type:
          - string
          - 'null'
          default: ''
          description: 'Retrieve the enabled state from the given dict of host variables. The enabled variable may be specified as "foo.bar", in which case the lookup will traverse into nested dicts, equivalent to: from_dict.get("foo", {}).get("bar", default)'
        enabled_value:
          type:
          - string
          - 'null'
          default: ''
          description: 'Only used when enabled_var is set. Value when the host is considered enabled. For example if enabled_var="status.power_state"and enabled_value="powered_on" with host variables:{   "status": {     "power_state": "powered_on",     "created": "2020-08-04T18:13:04+00:00",     "healthy": true    },    "name": "foobar",    "ip_address": "192.168.2.1"}The host would be marked enabled. If power_state where any value other than powered_on then the host would be disabled when imported. If the key is not found then the host will be enabled'
        host_filter:
          type:
          - string
          - 'null'
          default: ''
          description: This field is deprecated and will be removed in a future release. Regex where only matching hosts will be imported.
        overwrite:
          type:
          - boolean
          - 'null'
          default: false
          description: Overwrite local groups and hosts from remote inventory source.
        overwrite_vars:
          type:
          - boolean
          - 'null'
          default: false
          description: Overwrite local variables from remote inventory source.
        custom_virtualenv:
          type:
          - string
          - 'null'
          description: Local absolute file path containing a custom Python virtualenv to use
          readOnly: true
        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.
        verbosity:
          enum:
          - 0
          - 1
          - 2
          type: integer
          description: '* `0` - 0 (WARNING)

            * `1` - 1 (INFO)

            * `2` - 2 (DEBUG)'
          x-spec-enum-id: 48197bd695a06691
          default: 1
          minimum: 0
          maximum: 9223372036854775807
        limit:
          type:
          - string
          - 'null'
          default: ''
          description: Enter host, group or pattern match
        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_args:
          type: string
          readOnly: true
        job_cwd:
          type: string
          readOnly: true
        job_env:
          readOnly: true
        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.
        result_traceback:
          type: string
          readOnly: true
        event_processing_finished:
          type: boolean
          readOnly: true
          description: Indicates whether all of the events generated by this unified job have been saved to the database.
        launched_by:
          type: string
          readOnly: true
        work_unit_id:
          type:
          - string
          - 'null'
          readOnly: true
          description: The Receptor work unit ID associated with this job.
        inventory:
          type:
          - integer
          - 'null'
        inventory_source:
          type: integer
          readOnly: true
        license_error:
          type: boolean
          readOnly: true
        org_host_limit_error:
          type: boolean
          readOnly: true
        source_project_update:
          type:
          - integer
          - 'null'
          description: Inventory files from this Project Update were used for the inventory update.
        instance_group:
          type:
          - integer
          - 'null'
          description: The Instance group the job was run under
        scm_revision:
          type: string
          readOnly: true
          description: The SCM Revision from the Project used for this inventory update.  Only applicable to inventories source from scm
        source_project:
          type: string
          readOnly: true
          description: The project used for this job.
      required:
      - name
      - source
    Notification:
      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
        notification_template:
          type: integer
          readOnly: true
        error:
          type: string
          readOnly: true
        status:
          enum:
          - pending
          - successful
          - failed
          type: string
          description: '* `pending` - Pending

            * `successful` - Successful

            * `failed` - Failed'
          x-spec-enum-id: 91d6a0571e1ae0e7
          readOnly: true
        notifications_sent:
          type: integer
          readOnly: true
        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
        recipients:
          type: string
          readOnly: true
        subject:
          type: string
          readOnly: true
        body:
          type: string
          readOnly: true
          description: Notification body
      required:
      - notification_type