Make a GET request to this resource to retrieve a list of projects associated with the selected organization.

The resulting data structure contains:

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

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

Results

Each project data structure includes the following fields:

• id: Database ID for this project. (integer)
• type: Data type for this project. (choice)
• url: URL for this project. (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 was created. (datetime)
• modified: Timestamp when this project was last modified. (datetime)
• name: Name of this project. (string)
• description: Optional description of this project. (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
  • 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_track_submodules: Track submodules latest commits on defined branch. (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 last revision fetched by a project update (string)
• last_job_run: (datetime)
• last_job_failed: (boolean)
• next_job_run: (datetime)
• status: (choice)
  • new: New
  • pending: Pending
  • waiting: Waiting
  • running: Running
  • successful: Successful
  • failed: Failed
  • error: Error
  • canceled: Canceled
  • never updated: Never Updated
  • ok: OK
  • missing: Missing
• organization: The organization used to determine access to this template. (id)
• scm_update_on_launch: Update the project when a job is launched that uses the project. (boolean)
• scm_update_cache_timeout: The number of seconds after the last project update ran that a new project update will be launched as a job dependency. (integer)
• allow_override: Allow changing the SCM branch or revision in a job template that uses this project. (boolean)
• custom_virtualenv: Local absolute file path containing a custom Python virtualenv to use (string)
• default_environment: The default execution environment for jobs run using this project. (id)
• last_update_failed: (boolean)
• last_updated: (datetime)

Sorting

To specify that projects 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 Oracle Linux Automation Manaer) Search across related fields:

?related__search=findme