summaryrefslogtreecommitdiff
path: root/doc/api/jobs.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api/jobs.md')
-rw-r--r--doc/api/jobs.md16
1 files changed, 13 insertions, 3 deletions
diff --git a/doc/api/jobs.md b/doc/api/jobs.md
index 78af6b881aa..6647b53bcb4 100644
--- a/doc/api/jobs.md
+++ b/doc/api/jobs.md
@@ -43,6 +43,7 @@ Example of response
"started_at": "2015-12-24T17:54:27.722Z",
"finished_at": "2015-12-24T17:54:27.895Z",
"duration": 0.173,
+ "queued_duration": 0.010,
"artifacts_file": {
"filename": "artifacts.zip",
"size": 1000
@@ -67,7 +68,6 @@ Example of response
"status": "pending"
},
"ref": "master",
- "artifacts": [],
"runner": null,
"stage": "test",
"status": "failed",
@@ -107,6 +107,7 @@ Example of response
"started_at": "2015-12-24T17:54:24.729Z",
"finished_at": "2015-12-24T17:54:24.921Z",
"duration": 0.192,
+ "queued_duration": 0.023,
"artifacts_expire_at": "2016-01-23T17:54:24.921Z",
"tag_list": [
"docker runner", "win10-2004"
@@ -159,7 +160,7 @@ GET /projects/:id/pipelines/:pipeline_id/jobs
| Attribute | Type | Required | Description |
|-------------------|--------------------------------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `id` | integer/string | yes | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user. |
-| `pipeline_id` | integer | yes | ID of a pipeline. |
+| `pipeline_id` | integer | yes | ID of a pipeline. Can also be obtained in CI jobs via the [predefined CI variable](../ci/variables/predefined_variables.md) `CI_PIPELINE_ID`. |
| `scope` | string **or** array of strings | no | Scope of jobs to show. Either one of or an array of the following: `created`, `pending`, `running`, `failed`, `success`, `canceled`, `skipped`, or `manual`. All jobs are returned if `scope` is not provided. |
| `include_retried` | boolean | no | Include retried jobs in the response. Defaults to `false`. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/272627) in GitLab 13.9. |
@@ -187,6 +188,7 @@ Example of response
"started_at": "2015-12-24T17:54:24.729Z",
"finished_at": "2015-12-24T17:54:24.921Z",
"duration": 0.192,
+ "queued_duration": 0.023,
"artifacts_expire_at": "2016-01-23T17:54:24.921Z",
"tag_list": [
"docker runner", "ubuntu18"
@@ -241,6 +243,7 @@ Example of response
"started_at": "2015-12-24T17:54:27.722Z",
"finished_at": "2015-12-24T17:54:27.895Z",
"duration": 0.173,
+ "queued_duration": 0.023,
"artifacts_file": {
"filename": "artifacts.zip",
"size": 1000
@@ -339,6 +342,7 @@ Example of response
"started_at": "2015-12-24T17:54:27.722Z",
"finished_at": "2015-12-24T17:58:27.895Z",
"duration": 240,
+ "queued_duration": 0.123,
"id": 7,
"name": "teaspoon",
"pipeline": {
@@ -422,6 +426,7 @@ Example of response
"started_at": "2015-12-24T17:54:30.733Z",
"finished_at": "2015-12-24T17:54:31.198Z",
"duration": 0.465,
+ "queued_duration": 0.123,
"artifacts_expire_at": "2016-01-23T17:54:31.198Z",
"id": 8,
"name": "rubocop",
@@ -575,6 +580,7 @@ Example of response
"started_at": "2015-12-24T17:54:30.733Z",
"finished_at": "2015-12-24T17:54:31.198Z",
"duration": 0.465,
+ "queued_duration": 0.010,
"artifacts_expire_at": "2016-01-23T17:54:31.198Z",
"tag_list": [
"docker runner", "macos-10.15"
@@ -675,6 +681,7 @@ Example of response
"started_at": "2016-01-11T10:14:09.526Z",
"finished_at": null,
"duration": 8,
+ "queued_duration": 0.010,
"id": 42,
"name": "rubocop",
"ref": "master",
@@ -724,6 +731,7 @@ Example of response
"started_at": null,
"finished_at": null,
"duration": null,
+ "queued_duration": 0.010,
"id": 42,
"name": "rubocop",
"ref": "master",
@@ -784,6 +792,7 @@ Example of response
"started_at": "2016-01-11T10:13:33.506Z",
"finished_at": "2016-01-11T10:15:10.506Z",
"duration": 97.0,
+ "queued_duration": 0.010,
"status": "failed",
"tag": false,
"web_url": "https://example.com/foo/bar/-/jobs/42",
@@ -827,13 +836,14 @@ Example of response
"started_at": null,
"finished_at": null,
"duration": null,
+ "queued_duration": 0.010,
"id": 42,
"name": "rubocop",
"ref": "master",
"artifacts": [],
"runner": null,
"stage": "test",
- "status": "started",
+ "status": "pending",
"tag": false,
"web_url": "https://example.com/foo/bar/-/jobs/42",
"user": null