Jump to

• Request
• Response

List Project Updates for a Project

get

/api/v2/projects/{id}/project_updates/

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

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
• 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)
• execution_node: The node the job executed on. (string)
• launched_by: (field)
• work_unit_id: The Receptor work unit ID associated with this job. (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 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

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/ProjectUpdateList"
            },
            "type":"array"
        }
    },
    "required":[
        "count",
        "results"
    ],
    "type":"object"
}

Nested Schema : results

Type: array

Show Source

• Array of: object ProjectUpdateList

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

Nested Schema : ProjectUpdateList

Type: object

Show Source

• 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
• credential: integer
  Title: Credential
• 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.
• execution_node: string
  Title: Execution node

  Read Only: true

  Minimum Length: 1

  The node the job executed on.
• 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
• job_tags: string
  Title: Job tags

  Maximum Length: 1024

  Parts of the project update playbook that will be run.
• job_type: string
  Title: Job type

  Default Value: check

  Allowed Values: [ "run", "check" ]
• 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
• local_path: string
  Title: Local path

  Maximum Length: 1024

  Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project.
• modified: string
  Title: Modified

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

  Minimum Length: 1

  Maximum Length: 512
• project: string
  Title: Project

  Read Only: true
• related: string
  Title: Related

  Read Only: true
• scm_branch: string
  Title: SCM Branch

  Maximum Length: 256

  Specific branch, tag or commit to checkout.
• scm_clean: boolean
  Title: Scm clean

  Discard any local changes before syncing the project.
• scm_delete_on_update: boolean
  Title: Scm delete on update

  Delete the project before syncing.
• scm_refspec: string
  Title: SCM refspec

  Maximum Length: 1024

  For git projects, an additional refspec to fetch.
• scm_revision: string
  Title: SCM Revision

  Read Only: true

  Minimum Length: 1

  The SCM Revision discovered by this update for the given project and branch.
• scm_track_submodules: boolean
  Title: Scm track submodules

  Track submodules latest commits on defined branch.
• scm_type: string
  Title: SCM Type

  Allowed Values: [ "", "git", "svn", "insights", "archive" ]

  Specifies the source control system used to store the project.
• scm_url: string
  Title: SCM URL

  Maximum Length: 1024

  The location where the project is stored.
• 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
• timeout: integer
  Title: Timeout

  The amount of time (in seconds) to run before the task is canceled.
• 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":{
        "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"
        },
        "credential":{
            "title":"Credential",
            "type":"integer",
            "x-nullable":true
        },
        "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
        },
        "execution_node":{
            "description":"The node the job executed on.",
            "minLength":"1",
            "readOnly":true,
            "title":"Execution node",
            "type":"string"
        },
        "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"
        },
        "job_tags":{
            "description":"Parts of the project update playbook that will be run.",
            "maxLength":"1024",
            "title":"Job tags",
            "type":"string",
            "x-nullable":true
        },
        "job_type":{
            "default":"check",
            "enum":[
                "run",
                "check"
            ],
            "title":"Job type",
            "type":"string",
            "x-nullable":true
        },
        "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"
        },
        "local_path":{
            "description":"Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project.",
            "maxLength":"1024",
            "title":"Local path",
            "type":"string",
            "x-nullable":true
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "name":{
            "maxLength":"512",
            "minLength":"1",
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "project":{
            "readOnly":true,
            "title":"Project",
            "type":"string"
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "scm_branch":{
            "description":"Specific branch, tag or commit to checkout.",
            "maxLength":"256",
            "title":"SCM Branch",
            "type":"string",
            "x-nullable":true
        },
        "scm_clean":{
            "description":"Discard any local changes before syncing the project.",
            "title":"Scm clean",
            "type":"boolean",
            "x-nullable":true
        },
        "scm_delete_on_update":{
            "description":"Delete the project before syncing.",
            "title":"Scm delete on update",
            "type":"boolean",
            "x-nullable":true
        },
        "scm_refspec":{
            "description":"For git projects, an additional refspec to fetch.",
            "maxLength":"1024",
            "title":"SCM refspec",
            "type":"string",
            "x-nullable":true
        },
        "scm_revision":{
            "description":"The SCM Revision discovered by this update for the given project and branch.",
            "minLength":"1",
            "readOnly":true,
            "title":"SCM Revision",
            "type":"string"
        },
        "scm_track_submodules":{
            "description":"Track submodules latest commits on defined branch.",
            "title":"Scm track submodules",
            "type":"boolean",
            "x-nullable":true
        },
        "scm_type":{
            "description":"Specifies the source control system used to store the project.",
            "enum":[
                "",
                "git",
                "svn",
                "insights",
                "archive"
            ],
            "title":"SCM Type",
            "type":"string",
            "x-nullable":true
        },
        "scm_url":{
            "description":"The location where the project is stored.",
            "maxLength":"1024",
            "title":"SCM URL",
            "type":"string",
            "x-nullable":true
        },
        "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"
        },
        "timeout":{
            "description":"The amount of time (in seconds) to run before the task is canceled.",
            "title":"Timeout",
            "type":"integer"
        },
        "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