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
: Manualrelaunch
: Relaunchcallback
: Callbackscheduled
: Scheduleddependency
: Dependencyworkflow
: Workflowwebhook
: Webhooksync
: Syncscm
: SCM Update
status
: (choice)new
: Newpending
: Pendingwaiting
: Waitingrunning
: Runningsuccessful
: Successfulfailed
: Failederror
: Errorcanceled
: 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
: GitHubgitlab
: GitLabbitbucket_dc
: BitBucket DataCenter
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)skip_tags
: (string)job_tags
: (string)
Request
Supported Media Types
- application/json
Path Parameters
Back to Top
Response
Supported Media Types
- application/json
200 Response
Root Schema : WorkflowJob
Type:
Show Source
object
-
allow_simultaneous:
boolean
Title:
Allow simultaneous
-
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
-
description:
string
Title:
Description
-
elapsed:
string(decimal)
Title:
Elapsed
Read Only:true
Elapsed time in seconds that the job ran. -
extra_vars:
string
Title:
Extra vars
-
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
-
inventory:
integer
Title:
Inventory
Inventory applied as a prompt, assuming job template prompts for inventory -
is_sliced_job:
boolean
Title:
Is sliced job
-
job_args:
string
Title:
Job args
Read Only:true
Minimum Length:1
-
job_cwd:
string
Title:
Job cwd
Read Only:true
Minimum Length:1
-
job_env:
object job_env
Title:
job_env
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
-
job_template:
string
Title:
Job template
If automatically created for a sliced job run, the job template the workflow job was created from. -
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
-
limit:
string
Title:
Limit
-
modified:
string
Title:
Modified
Read Only:true
-
name(required):
string
Title:
Name
Minimum Length:1
Maximum Length:512
- related: string
-
result_traceback:
string
Title:
Result traceback
Read Only:true
Minimum Length:1
-
scm_branch:
string
Title:
Scm branch
-
skip_tags:
string
Title:
Skip tags
-
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
-
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
-
webhook_credential:
integer
Title:
Webhook credential
Personal Access Token for posting back the status to the service API -
webhook_guid:
string
Title:
Webhook guid
Maximum Length:128
Unique identifier of the event that triggered this webhook -
webhook_service:
string
Title:
Webhook service
Allowed Values:[ "github", "gitlab", "bitbucket_dc" ]
Service that webhook requests will be accepted from -
work_unit_id:
string
Title:
Work unit id
Read Only:true
Minimum Length:1
The Receptor work unit ID associated with this job. -
workflow_job_template:
string
Title:
Workflow job template
Nested Schema : job_env
Type:
object
Title:
job_env
Read Only:
true