openapi: 3.2.0 info: title: AWX Workflow Approvals API version: v2 description: AWX API Documentation contact: email: ansible-community@redhat.com license: name: Apache License tags: - name: workflow_approvals paths: /api/v2/workflow_approvals/: get: operationId: workflow_approvals_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: - workflow_approvals responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedWorkflowApprovalListList' description: '' x-ai-description: List workflow approvals summary: Workflow approvals list x-summary-source: derived /api/v2/workflow_approvals/{id}/: get: operationId: workflow_approvals_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: - workflow_approvals responses: '200': content: application/json: schema: $ref: '#/components/schemas/WorkflowApproval' description: '' x-ai-description: Retrieve a workflow approval summary: Workflow approvals retrieve x-summary-source: derived delete: operationId: workflow_approvals_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: - workflow_approvals responses: '204': description: No response body x-ai-description: Delete a workflow approval summary: Workflow approvals destroy x-summary-source: derived /api/v2/workflow_approvals/{id}/approve/: get: operationId: workflow_approvals_approve_retrieve parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - workflow_approvals responses: '200': description: No response body x-ai-description: Retrieve single approve for a workflow_approval summary: Workflow approvals approve retrieve x-summary-source: derived post: operationId: workflow_approvals_approve_create parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - workflow_approvals responses: '200': description: No response body x-ai-description: Approve a workflow approval summary: Workflow approvals approve create x-summary-source: derived /api/v2/workflow_approvals/{id}/deny/: get: operationId: workflow_approvals_deny_retrieve parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - workflow_approvals responses: '200': description: No response body x-ai-description: Retrieve single deny for a workflow_approval summary: Workflow approvals deny retrieve x-summary-source: derived post: operationId: workflow_approvals_deny_create parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - workflow_approvals responses: '200': description: No response body x-ai-description: Deny a workflow approval summary: Workflow approvals deny create x-summary-source: derived components: schemas: WorkflowApprovalList: 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 launched_by: type: string readOnly: true work_unit_id: type: - string - 'null' readOnly: true description: The Receptor work unit ID associated with this job. can_approve_or_deny: type: string readOnly: true approval_expiration: type: string readOnly: true timed_out: type: boolean description: Shows when an approval node (with a timeout assigned to it) has timed out. readOnly: true required: - name PaginatedWorkflowApprovalListList: 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/WorkflowApprovalList' WorkflowApproval: 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_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 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. can_approve_or_deny: type: string readOnly: true approval_expiration: type: string readOnly: true timed_out: type: boolean description: Shows when an approval node (with a timeout assigned to it) has timed out. readOnly: true required: - name