Jobs
A list of jobs.
Currently this is nested within a build.
Attributes
Name | Type | Description |
---|---|---|
jobs | [Job] | List of jobs. |
Collection Items
Each entry in the jobs array has the following attributes:
Name | Type | Description |
---|---|---|
id | Integer | Value uniquely identifying the job. |
allow_failure | Unknown | The job's allow_failure. |
number | String | Incremental number for a repository's builds. |
state | String | Current state of the job. |
started_at | String | When the job started. |
finished_at | String | When the job finished. |
build | Build | The build the job is associated with. |
queue | String | Worker queue this job is/was scheduled on. |
repository | Repository | GitHub user or organization the job belongs to. |
commit | Commit | The commit the job is associated with. |
owner | Owner | GitHub user or organization the job belongs to. |
stage | [Stage] | The stages of the job. |
created_at | String | When the job was created. |
updated_at | String | When the job was updated. |
private | Boolean | Whether or not the job is private. |
restarted_at | Unknown | The job's restarted_at. |
restarted_by | Unknown | The job's restarted_by. |
vm_size | Unknown | The job's vm_size. |
config | Object | The job's config. |
log_complete | Unknown | The job's log_complete. |
Actions
Find
This returns a list of jobs belonging to an individual build.
GET
/build/{build.id}/jobs
Template Variable | Type | Description |
---|---|---|
build.id | Integer | Value uniquely identifying the build. |
Query Parameter | Type | Description |
---|---|---|
include | [String] | List of attributes to eager load. |
Example:GET /build/86601346/jobs
For Current User
This returns a list of jobs a current user has access to.
GET
/jobs
Query Parameter | Type | Description |
---|---|---|
active | Unknown | Alias for job.active. |
created_by | Unknown | Alias for job.created_by. |
include | [String] | List of attributes to eager load. |
job.active | Unknown | Documentation missing. |
job.created_by | Unknown | Documentation missing. |
job.state | [String] | Filters jobs by current state of the job. |
limit | Integer | How many jobs to include in the response. Used for pagination. |
offset | Integer | How many jobs to skip before the first entry in the response. Used for pagination. |
sort_by | [String] | Attributes to sort jobs by. Used for pagination. |
state | [String] | Alias for job.state. |
Example:GET /jobs?limit=5
Sortable by: id, state, append :desc to any attribute to reverse order.
The default value is id:desc,state.