1. Oracle Linux Automation Manager CLI and API Reference Guide 2.1
  2. Tasks
  3. Project Updates

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)
    • "": 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)
  • 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_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: Run
    • check: Check
  • job_tags: Parts of the project update playbook that will be run. (string)
  • host_status_counts: A count of hosts uniquely assigned to each status. (field)
  • playbook_counts: A count of all plays and tasks for the job run. (field)

Request

Supported Media Types
Path Parameters
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

Body
Example Response (application/json)
{
    "canceled_on":null,
    "created":"2018-02-01T08:00:00.000000Z",
    "credential":null,
    "description":"",
    "elapsed":"0",
    "event_processing_finished":false,
    "execution_environment":null,
    "execution_node":"",
    "failed":false,
    "finished":null,
    "host_status_counts":{
    },
    "id":"2",
    "job_args":"",
    "job_cwd":"",
    "job_env":{
    },
    "job_explanation":"",
    "job_tags":"update_,install_roles,install_collections",
    "job_type":"check",
    "launch_type":"manual",
    "launched_by":{
    },
    "local_path":"",
    "modified":"2018-02-01T08:00:00.000000Z",
    "name":"",
    "playbook_counts":{
        "play_count":"0",
        "task_count":"0"
    },
    "project":"2",
    "related":{
        "cancel":"/api/v2/project_updates/2/cancel/",
        "events":"/api/v2/project_updates/2/events/",
        "notifications":"/api/v2/project_updates/2/notifications/",
        "project":"/api/v2/projects/2/",
        "scm_inventory_updates":"/api/v2/project_updates/2/scm_inventory_updates/",
        "stdout":"/api/v2/project_updates/2/stdout/",
        "unified_job_template":"/api/v2/projects/2/"
    },
    "result_traceback":"",
    "scm_branch":"",
    "scm_clean":false,
    "scm_delete_on_update":false,
    "scm_refspec":"",
    "scm_revision":"",
    "scm_track_submodules":false,
    "scm_type":"",
    "scm_url":"",
    "started":null,
    "status":"new",
    "summary_fields":{
        "project":{
            "allow_override":false,
            "description":"test-proj-desc",
            "id":"2",
            "name":"test-proj",
            "scm_type":"git",
            "status":"never updated"
        },
        "unified_job_template":{
            "description":"test-proj-desc",
            "id":"2",
            "name":"test-proj",
            "unified_job_type":"project_update"
        },
        "user_capabilities":{
            "delete":true,
            "start":true
        }
    },
    "timeout":"0",
    "type":"project_update",
    "unified_job_template":"2",
    "url":"/api/v2/project_updates/2/",
    "work_unit_id":null
}
Back to Top