Make a GET request to this resource to retrieve the list of project updates.

The resulting data structure contains:

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

The count field indicates the total number of project updates 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 project update records.

Results

Each project update data structure includes the following fields:

• id: Database ID for this project update. (integer)
• type: Data type for this project update. (choice)
• url: URL for this project update. (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 project update was created. (datetime)
• modified: Timestamp when this project update was last modified. (datetime)
• name: Name of this project update. (string)
• description: Optional description of this project update. (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
• 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)
• execution_node: The node the job executed on. (string)
• local_path: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. (string)
• scm_type: Specifies the source control system used to store the project. (choice)
  • "": Manual
  • git: Git
  • hg: Mercurial
  • svn: Subversion
  • insights: Red Hat Insights
  • archive: Remote Archive
• scm_url: The location where the project is stored. (string)
• scm_branch: Specific branch, tag or commit to checkout. (string)
• scm_refspec: For git projects, an additional refspec to fetch. (string)
• scm_clean: Discard any local changes before syncing the project. (boolean)
• scm_delete_on_update: Delete the project before syncing. (boolean)
• credential: (id)
• timeout: The amount of time (in seconds) to run before the task is canceled. (integer)
• scm_revision: The SCM Revision discovered by this update for the given project and branch. (string)
• project: (id)
• job_type: (choice)
  • run: Run
  • check: Check
• job_tags: Parts of the project update playbook that will be run. (string)

Sorting

To specify that project updates 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