diff options
Diffstat (limited to 'doc/api/jobs.md')
| -rw-r--r-- | doc/api/jobs.md | 21 |
1 files changed, 16 insertions, 5 deletions
diff --git a/doc/api/jobs.md b/doc/api/jobs.md index 594add64b0a..886f209520d 100644 --- a/doc/api/jobs.md +++ b/doc/api/jobs.md @@ -46,6 +46,7 @@ Example of response "title": "Test the CI integration." }, "coverage": null, + "archived": false, "allow_failure": false, "created_at": "2015-12-24T15:51:21.802Z", "started_at": "2015-12-24T17:54:27.722Z", @@ -115,6 +116,7 @@ Example of response "title": "Test the CI integration." }, "coverage": null, + "archived": false, "allow_failure": false, "created_at": "2015-12-24T15:51:21.727Z", "started_at": "2015-12-24T17:54:24.729Z", @@ -187,8 +189,8 @@ GET /projects/:id/pipelines/:pipeline_id/jobs |-------------------|--------------------------------|----------|-------------| | `id` | integer/string | Yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding). | | `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`, `waiting_for_resource`, 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. | +| `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`, `waiting_for_resource`, or `manual`. All jobs are returned if `scope` is not provided. | ```shell curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/pipelines/6/jobs?scope[]=pending&scope[]=running" @@ -209,6 +211,7 @@ Example of response "title": "Test the CI integration." }, "coverage": null, + "archived": false, "allow_failure": false, "created_at": "2015-12-24T15:51:21.727Z", "started_at": "2015-12-24T17:54:24.729Z", @@ -269,6 +272,7 @@ Example of response "title": "Test the CI integration." }, "coverage": null, + "archived": false, "allow_failure": false, "created_at": "2015-12-24T15:51:21.802Z", "started_at": "2015-12-24T17:54:27.722Z", @@ -363,6 +367,7 @@ Example of response "title": "Test the CI integration." }, "coverage": null, + "archived": false, "allow_failure": false, "created_at": "2015-12-24T15:51:21.802Z", "started_at": "2015-12-24T17:54:27.722Z", @@ -450,6 +455,7 @@ Example of response "title": "Test the CI integration." }, "coverage": null, + "archived": false, "allow_failure": false, "created_at": "2015-12-24T15:51:21.880Z", "started_at": "2015-12-24T17:54:30.733Z", @@ -600,6 +606,7 @@ Example of response "title": "Test the CI integration." }, "coverage": null, + "archived": false, "allow_failure": false, "created_at": "2015-12-24T15:51:21.880Z", "started_at": "2015-12-24T17:54:30.733Z", @@ -669,10 +676,10 @@ curl --location --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.ex Possible response status codes: -| Status | Description | -|-----------|-------------------------------| -| 200 | Serves the log file | -| 404 | Job not found or no log file | +| Status | Description | +|--------|-------------| +| 200 | Serves the log file | +| 404 | Job not found or no log file | ## Cancel a job @@ -705,6 +712,7 @@ Example of response "title": "Test the CI integration." }, "coverage": null, + "archived": false, "allow_failure": false, "created_at": "2016-01-11T10:13:33.506Z", "started_at": "2016-01-11T10:14:09.526Z", @@ -759,6 +767,7 @@ Example of response "title": "Test the CI integration." }, "coverage": null, + "archived": false, "allow_failure": false, "created_at": "2016-01-11T10:13:33.506Z", "started_at": null, @@ -817,6 +826,7 @@ Example of response "title": "Test the CI integration." }, "coverage": null, + "archived": false, "allow_failure": false, "download_url": null, "id": 1, @@ -899,6 +909,7 @@ Example response: "title": "Test the CI integration." }, "coverage": null, + "archived": false, "allow_failure": false, "created_at": "2016-01-11T10:13:33.506Z", "started_at": null, |