Jump to

• Request
• Response

Retrieve a Workflow Job

get

/api/v2/workflow_jobs/{id}/

Make GET request to this resource to retrieve a single workflow job record containing the following fields:

• id: Database ID for this workflow job. (integer)
• type: Data type for this workflow job. (choice)
• url: URL for this workflow job. (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 workflow job was created. (datetime)
• modified: Timestamp when this workflow job was last modified. (datetime)
• name: Name of this workflow job. (string)
• description: Optional description of this workflow job. (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_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)
• result_traceback: (string)
• launched_by: (field)
• work_unit_id: The Receptor work unit ID associated with this job. (string)
• workflow_job_template: (id)
• extra_vars: (json)
• allow_simultaneous: (boolean)
• job_template: If automatically created for a sliced job run, the job template the workflow job was created from. (id)
• is_sliced_job: (boolean)
• inventory: Inventory applied as a prompt, assuming job template prompts for inventory (id)
• limit: (string)
• scm_branch: (string)
• webhook_service: Service that webhook requests will be accepted from (choice)
  • "": ---------
  • github: GitHub
  • gitlab: GitLab
• webhook_credential: Personal Access Token for posting back the status to the service API (id)
• webhook_guid: Unique identifier of the event that triggered this webhook (string)

Request

Supported Media Types

• application/json

Path Parameters

• id(required): string

Query Parameters

• search: string
  A search term.

Back to Top

Response

200 Response

Back to Top