Retrieve a Project Update
get
/api/v2/project_updates/{id}/
Make GET request to this resource to retrieve a single project update record containing 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)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)"": Manualgit: Gitsvn: Subversioninsights: Red Hat Insightsarchive: 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)unified_job_template: (id)launch_type: (choice)manual: Manualrelaunch: Relaunchcallback: Callbackscheduled: Scheduleddependency: Dependencyworkflow: Workflowwebhook: Webhooksync: Syncscm: SCM Update
status: (choice)new: Newpending: Pendingwaiting: Waitingrunning: Runningsuccessful: Successfulfailed: Failederror: Errorcanceled: 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_args: (string)job_cwd: (string)job_env: (json)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)result_traceback: (string)event_processing_finished: Indicates whether all of the events generated by this unified job have been saved to the database. (boolean)launched_by: (field)work_unit_id: The Receptor work unit ID associated with this job. (string)project: (id)job_type: (choice)run: Runcheck: Check
job_tags: Parts of the project update playbook that will be run. (string)host_status_counts: Playbook stats from the Ansible playbook_on_stats event. (json)playbook_counts: A count of all plays and tasks for the job run. (field)
Request
Supported Media Types
- application/json
Path Parameters
Back to Top
Response
Supported Media Types
- application/json
200 Response
Root Schema : ProjectUpdateDetail
Type:
Show Source
object-
canceled_on:
string(date-time)
Title:
Canceled onRead Only:trueThe date and time when the cancel request was sent. -
created:
string
Title:
CreatedRead Only:true -
credential:
integer
Title:
Credential -
description:
string
Title:
Description -
elapsed:
string(decimal)
Title:
ElapsedRead Only:trueElapsed time in seconds that the job ran. -
event_processing_finished:
boolean
Title:
Event processing finishedRead Only:trueIndicates whether all of the events generated by this unified job have been saved to the database. -
execution_environment:
integer
Title:
Execution environmentThe container image to be used for execution. -
execution_node:
string
Title:
Execution nodeRead Only:trueMinimum Length:1The node the job executed on. -
failed:
boolean
Title:
FailedRead Only:true -
finished:
string(date-time)
Title:
FinishedRead Only:trueThe date and time the job finished execution. -
host_status_counts:
object Host status counts
Title:
Host status countsRead Only:truePlaybook stats from the Ansible playbook_on_stats event. -
id:
integer
Title:
IDRead Only:true -
job_args:
string
Title:
Job argsRead Only:trueMinimum Length:1 -
job_cwd:
string
Title:
Job cwdRead Only:trueMinimum Length:1 -
job_env:
object job_env
Title:
job_envRead Only:true -
job_explanation:
string
Title:
Job explanationRead Only:trueMinimum Length:1A status field to indicate the state of the job if it wasn't able to run and capture stdout -
job_tags:
string
Title:
Job tagsMaximum Length:1024Parts of the project update playbook that will be run. -
job_type:
string
Title:
Job typeDefault Value:checkAllowed Values:[ "run", "check" ] -
launch_type:
string
Title:
Launch typeRead Only:trueAllowed Values:[ "manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm" ] -
launched_by:
string
Title:
Launched byRead Only:true -
local_path:
string
Title:
Local pathMaximum Length:1024Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. -
modified:
string
Title:
ModifiedRead Only:true -
name(required):
string
Title:
NameMinimum Length:1Maximum Length:512 -
playbook_counts:
string
Title:
Playbook countsRead Only:trueA count of all plays and tasks for the job run. -
project:
string
Title:
ProjectRead Only:true - related: string
-
result_traceback:
string
Title:
Result tracebackRead Only:trueMinimum Length:1 -
scm_branch:
string
Title:
SCM BranchMaximum Length:256Specific branch, tag or commit to checkout. -
scm_clean:
boolean
Title:
Scm cleanDiscard any local changes before syncing the project. -
scm_delete_on_update:
boolean
Title:
Scm delete on updateDelete the project before syncing. -
scm_refspec:
string
Title:
SCM refspecMaximum Length:1024For git projects, an additional refspec to fetch. -
scm_revision:
string
Title:
SCM RevisionRead Only:trueMinimum Length:1The SCM Revision discovered by this update for the given project and branch. -
scm_track_submodules:
boolean
Title:
Scm track submodulesTrack submodules latest commits on defined branch. -
scm_type:
string
Title:
SCM TypeAllowed Values:[ "", "git", "svn", "insights", "archive" ]Specifies the source control system used to store the project. -
scm_url:
string
Title:
SCM URLMaximum Length:1024The location where the project is stored. -
started:
string(date-time)
Title:
StartedRead Only:trueThe date and time the job was queued for starting. -
status:
string
Title:
StatusRead Only:trueAllowed Values:[ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled" ] -
summary_fields:
string
Title:
Summary fieldsRead Only:true -
timeout:
integer
Title:
TimeoutThe amount of time (in seconds) to run before the task is canceled. -
type:
string
Title:
TypeRead Only:true -
unified_job_template:
string
Title:
unified job templateRead Only:true -
url:
string
Title:
UrlRead Only:true -
work_unit_id:
string
Title:
Work unit idRead Only:trueMinimum Length:1The Receptor work unit ID associated with this job.
Nested Schema : Host status counts
Type:
objectTitle:
Host status countsRead Only:
truePlaybook stats from the Ansible playbook_on_stats event.
Nested Schema : job_env
Type:
objectTitle:
job_envRead Only:
true