Jump to

• Request
• Response

List Workflow Approvals for a Workflow Approval Template

get

/api/v2/workflow_approval_templates/{id}/approvals/

Make a GET request to this resource to retrieve a list of workflow approvals associated with the selected workflow approval template.

The resulting data structure contains:

{
    "count": 99,
    "next": null,
    "previous": null,
    "results": [
        ...
    ]
}

The count field indicates the total number of workflow approvals found for the given query. The next and previous fields provides links to additional results if there are more than will fit on a single page. The results list contains zero or more workflow approval records.

Results

Each workflow approval data structure includes the following fields:

• id: Database ID for this workflow approval. (integer)
• type: Data type for this workflow approval. (choice)
• url: URL for this workflow approval. (string)
• related: Data structure with URLs of related resources. (object)
• summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
• created: Timestamp when this workflow approval was created. (datetime)
• modified: Timestamp when this workflow approval was last modified. (datetime)
• name: Name of this workflow approval. (string)
• description: Optional description of this workflow approval. (string)
• unified_job_template: (id)
• launch_type: (choice)
  • manual: Manual
  • relaunch: Relaunch
  • callback: Callback
  • scheduled: Scheduled
  • dependency: Dependency
  • workflow: Workflow
  • webhook: Webhook
  • sync: Sync
  • scm: SCM Update
• status: (choice)
  • new: New
  • pending: Pending
  • waiting: Waiting
  • running: Running
  • successful: Successful
  • failed: Failed
  • error: Error
  • canceled: Canceled
• execution_environment: The container image to be used for execution. (id)
• failed: (boolean)
• started: The date and time the job was queued for starting. (datetime)
• finished: The date and time the job finished execution. (datetime)
• canceled_on: The date and time when the cancel request was sent. (datetime)
• elapsed: Elapsed time in seconds that the job ran. (decimal)
• job_explanation: A status field to indicate the state of the job if it wasn't able to run and capture stdout (string)
• launched_by: (field)
• work_unit_id: The Receptor work unit ID associated with this job. (string)
• can_approve_or_deny: (field)
• approval_expiration: (field)
• timed_out: (boolean)

Sorting

To specify that workflow approvals are returned in a particular order, use the order_by query string parameter on the GET request.

?order_by=name

Prefix the field name with a dash - to sort in reverse:

?order_by=-name

Multiple sorting fields may be specified by separating the field names with a comma ,:

?order_by=name,some_other_field

Pagination

Use the page_size query string parameter to change the number of results returned for each request. Use the page query string parameter to retrieve a particular page of results.

?page_size=100&page=2

The previous and next links returned with the results will set these query string parameters automatically.

Searching

Use the search query string parameter to perform a case-insensitive search within all designated text fields of a model.

?search=findme

(Added in Ansible Tower 3.1.0) Search across related fields:

?related__search=findme

Request

Supported Media Types

• application/json

Path Parameters

• id(required): string

Query Parameters

• page: integer
  A page number within the paginated result set.
• page_size: integer
  Number of results to return per page.
• search: string
  A search term.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Body ()

Root Schema : schema

Type: object

Show Source

• count(required): integer
• next: string(uri)
• previous: string(uri)
• results(required): array results

{
    "properties":{
        "count":{
            "type":"integer"
        },
        "next":{
            "format":"uri",
            "type":"string",
            "x-nullable":true
        },
        "previous":{
            "format":"uri",
            "type":"string",
            "x-nullable":true
        },
        "results":{
            "items":{
                "$ref":"#/definitions/WorkflowApprovalList"
            },
            "type":"array"
        }
    },
    "required":[
        "count",
        "results"
    ],
    "type":"object"
}

Nested Schema : results

Type: array

Show Source

• Array of: object WorkflowApprovalList

{
    "items":{
        "$ref":"#/definitions/WorkflowApprovalList"
    },
    "type":"array"
}

Nested Schema : WorkflowApprovalList

Type: object

Show Source

• approval_expiration: string
  Title: Approval expiration

  Read Only: true
• can_approve_or_deny: string
  Title: Can approve or deny

  Read Only: true
• canceled_on: string(date-time)
  Title: Canceled on

  Read Only: true

  The date and time when the cancel request was sent.
• created: string
  Title: Created

  Read Only: true
• description: string
  Title: Description
• elapsed: string(decimal)
  Title: Elapsed

  Read Only: true

  Elapsed time in seconds that the job ran.
• execution_environment: integer
  Title: Execution environment

  The container image to be used for execution.
• failed: boolean
  Title: Failed

  Read Only: true
• finished: string(date-time)
  Title: Finished

  Read Only: true

  The date and time the job finished execution.
• id: integer
  Title: ID

  Read Only: true
• job_explanation: string
  Title: Job explanation

  Read Only: true

  Minimum Length: 1

  A status field to indicate the state of the job if it wasn't able to run and capture stdout
• launch_type: string
  Title: Launch type

  Read Only: true

  Allowed Values: [ "manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm" ]
• launched_by: string
  Title: Launched by

  Read Only: true
• modified: string
  Title: Modified

  Read Only: true
• name(required): string
  Title: Name

  Minimum Length: 1

  Maximum Length: 512
• related: string
  Title: Related

  Read Only: true
• started: string(date-time)
  Title: Started

  Read Only: true

  The date and time the job was queued for starting.
• status: string
  Title: Status

  Read Only: true

  Allowed Values: [ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled" ]
• summary_fields: string
  Title: Summary fields

  Read Only: true
• timed_out: string
  Title: Timed out

  Read Only: true
• type: string
  Title: Type

  Read Only: true
• unified_job_template: string
  Title: unified job template

  Read Only: true
• url: string
  Title: Url

  Read Only: true
• work_unit_id: string
  Title: Work unit id

  Read Only: true

  Minimum Length: 1

  The Receptor work unit ID associated with this job.

{
    "properties":{
        "approval_expiration":{
            "readOnly":true,
            "title":"Approval expiration",
            "type":"string"
        },
        "can_approve_or_deny":{
            "readOnly":true,
            "title":"Can approve or deny",
            "type":"string"
        },
        "canceled_on":{
            "description":"The date and time when the cancel request was sent.",
            "format":"date-time",
            "readOnly":true,
            "title":"Canceled on",
            "type":"string",
            "x-nullable":true
        },
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "elapsed":{
            "description":"Elapsed time in seconds that the job ran.",
            "format":"decimal",
            "readOnly":true,
            "title":"Elapsed",
            "type":"string"
        },
        "execution_environment":{
            "description":"The container image to be used for execution.",
            "title":"Execution environment",
            "type":"integer",
            "x-nullable":true
        },
        "failed":{
            "readOnly":true,
            "title":"Failed",
            "type":"boolean"
        },
        "finished":{
            "description":"The date and time the job finished execution.",
            "format":"date-time",
            "readOnly":true,
            "title":"Finished",
            "type":"string",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "job_explanation":{
            "description":"A status field to indicate the state of the job if it wasn't able to run and capture stdout",
            "minLength":"1",
            "readOnly":true,
            "title":"Job explanation",
            "type":"string"
        },
        "launch_type":{
            "enum":[
                "manual",
                "relaunch",
                "callback",
                "scheduled",
                "dependency",
                "workflow",
                "webhook",
                "sync",
                "scm"
            ],
            "readOnly":true,
            "title":"Launch type",
            "type":"string"
        },
        "launched_by":{
            "readOnly":true,
            "title":"Launched by",
            "type":"string"
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "name":{
            "maxLength":"512",
            "minLength":"1",
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "started":{
            "description":"The date and time the job was queued for starting.",
            "format":"date-time",
            "readOnly":true,
            "title":"Started",
            "type":"string",
            "x-nullable":true
        },
        "status":{
            "enum":[
                "new",
                "pending",
                "waiting",
                "running",
                "successful",
                "failed",
                "error",
                "canceled"
            ],
            "readOnly":true,
            "title":"Status",
            "type":"string"
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "timed_out":{
            "readOnly":true,
            "title":"Timed out",
            "type":"string"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "unified_job_template":{
            "readOnly":true,
            "title":"unified job template",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        },
        "work_unit_id":{
            "description":"The Receptor work unit ID associated with this job.",
            "minLength":"1",
            "readOnly":true,
            "title":"Work unit id",
            "type":"string",
            "x-nullable":true
        }
    },
    "required":[
        "name"
    ],
    "type":"object"
}

Back to Top