debian-mirror-gitlab/doc/api/issues.md

1727 lines
71 KiB
Markdown
Raw Normal View History

2017-09-10 17:25:29 +05:30
# Issues API
2014-09-02 18:07:02 +05:30
2016-04-02 18:10:28 +05:30
Every API call to issues must be authenticated.
If a user is not a member of a project and the project is private, a `GET`
2019-09-30 21:07:59 +05:30
request on that project will result in a `404` status code.
2016-04-02 18:10:28 +05:30
## Issues pagination
By default, `GET` requests return 20 results at a time because the API results
are paginated.
Read more on [pagination](README.md#pagination).
2020-03-13 15:44:24 +05:30
CAUTION: **Deprecation**
> `reference` attribute in response is deprecated in favour of `references`.
> Introduced [GitLab 12.6](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/20354)
NOTE: **Note**
> `references.relative` is relative to the group / project that the issue is being requested. When issue is fetched from its project
> `relative` format would be the same as `short` format and when requested across groups / projects it is expected to be the same as `full` format.
2014-09-02 18:07:02 +05:30
## List issues
2017-09-10 17:25:29 +05:30
Get all issues the authenticated user has access to. By default it
returns only issues created by the current user. To get all issues,
use parameter `scope=all`.
2014-09-02 18:07:02 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2014-09-02 18:07:02 +05:30
GET /issues
2015-04-26 12:48:37 +05:30
GET /issues?state=opened
GET /issues?state=closed
GET /issues?labels=foo
GET /issues?labels=foo,bar
GET /issues?labels=foo,bar&state=opened
2017-08-17 22:00:37 +05:30
GET /issues?milestone=1.0.0
GET /issues?milestone=1.0.0&state=opened
GET /issues?iids[]=42&iids[]=43
2017-09-10 17:25:29 +05:30
GET /issues?author_id=5
GET /issues?assignee_id=5
2018-03-17 18:26:18 +05:30
GET /issues?my_reaction_emoji=star
2019-03-02 22:35:43 +05:30
GET /issues?search=foo&in=title
2019-07-07 11:18:12 +05:30
GET /issues?confidential=true
2018-03-17 18:26:18 +05:30
```
| Attribute | Type | Required | Description |
| ------------------- | ---------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
2019-09-04 21:01:54 +05:30
| `state` | string | no | Return `all` issues or just those that are `opened` or `closed` |
2019-02-15 15:39:39 +05:30
| `labels` | string | no | Comma-separated list of label names, issues must have all labels to be returned. `None` lists all issues with no labels. `Any` lists all issues with at least one label. `No+Label` (Deprecated) lists all issues with no labels. Predefined names are case-insensitive. |
2020-04-08 14:13:33 +05:30
| `with_labels_details` | boolean | no | If `true`, response will return more details for each label in labels field: `:name`, `:color`, `:description`, `:description_html`, `:text_color`. Default is `false`. The `description_html` attribute was introduced in [GitLab 12.7](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/21413)|
2018-12-13 13:39:08 +05:30
| `milestone` | string | no | The milestone title. `None` lists all issues with no milestone. `Any` lists all issues that have an assigned milestone. |
2018-11-08 19:23:39 +05:30
| `scope` | string | no | Return issues for the given scope: `created_by_me`, `assigned_to_me` or `all`. Defaults to `created_by_me`<br> For versions before 11.0, use the now deprecated `created-by-me` or `assigned-to-me` scopes instead.<br> _([Introduced][ce-13004] in GitLab 9.5. [Changed to snake_case][ce-18935] in GitLab 11.0)_ |
2019-09-04 21:01:54 +05:30
| `author_id` | integer | no | Return issues created by the given user `id`. Mutually exclusive with `author_username`. Combine with `scope=all` or `scope=assigned_to_me`. _([Introduced][ce-13004] in GitLab 9.5)_ |
2019-09-30 21:07:59 +05:30
| `author_username` | string | no | Return issues created by the given `username`. Similar to `author_id` and mutually exclusive with `author_id`. |
2019-09-04 21:01:54 +05:30
| `assignee_id` | integer | no | Return issues assigned to the given user `id`. Mutually exclusive with `assignee_username`. `None` returns unassigned issues. `Any` returns issues with an assignee. _([Introduced][ce-13004] in GitLab 9.5)_ |
2019-09-30 21:07:59 +05:30
| `assignee_username` | string array | no | Return issues assigned to the given `username`. Similar to `assignee_id` and mutually exclusive with `assignee_id`. In CE version `assignee_username` array should only contain a single value or an invalid param error will be returned otherwise. |
2018-12-13 13:39:08 +05:30
| `my_reaction_emoji` | string | no | Return issues reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns issues given at least one reaction. _([Introduced][ce-14016] in GitLab 10.0)_ |
2019-09-30 21:07:59 +05:30
| `weight` **(STARTER)** | integer | no | Return issues with the specified `weight`. `None` returns issues with no weight assigned. `Any` returns issues with a weight assigned. |
| `iids[]` | integer array | no | Return only the issues having the given `iid` |
2019-12-04 20:38:33 +05:30
| `order_by` | string | no | Return issues ordered by `created_at`, `updated_at`, `priority`, `due_date`, `relative_position`, `label_priority`, `milestone_due`, `popularity`, `weight` fields. Default is `created_at` |
2018-03-17 18:26:18 +05:30
| `sort` | string | no | Return issues sorted in `asc` or `desc` order. Default is `desc` |
| `search` | string | no | Search issues against their `title` and `description` |
2019-09-04 21:01:54 +05:30
| `in` | string | no | Modify the scope of the `search` attribute. `title`, `description`, or a string joining them with comma. Default is `title,description` |
2018-03-27 19:54:05 +05:30
| `created_after` | datetime | no | Return issues created on or after the given time |
| `created_before` | datetime | no | Return issues created on or before the given time |
| `updated_after` | datetime | no | Return issues updated on or after the given time |
| `updated_before` | datetime | no | Return issues updated on or before the given time |
2020-04-08 14:13:33 +05:30
| `confidential` | boolean | no | Filter confidential or public issues. |
2019-12-21 20:55:43 +05:30
| `not` | Hash | no | Return issues that do not match the parameters supplied. Accepts: `labels`, `milestone`, `author_id`, `author_username`, `assignee_id`, `assignee_username`, `my_reaction_emoji`, `search`, `in` |
2016-04-02 18:10:28 +05:30
2020-03-13 15:44:24 +05:30
```shell
2019-02-15 15:39:39 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/issues
2016-04-02 18:10:28 +05:30
```
2015-04-26 12:48:37 +05:30
2016-04-02 18:10:28 +05:30
Example response:
2015-04-26 12:48:37 +05:30
2014-09-02 18:07:02 +05:30
```json
[
2016-04-02 18:10:28 +05:30
{
"state" : "opened",
"description" : "Ratione dolores corrupti mollitia soluta quia.",
"author" : {
"state" : "active",
"id" : 18,
2016-11-03 12:29:30 +05:30
"web_url" : "https://gitlab.example.com/eileen.lowe",
2016-04-02 18:10:28 +05:30
"name" : "Alexandra Bashirian",
"avatar_url" : null,
"username" : "eileen.lowe"
},
"milestone" : {
"project_id" : 1,
"description" : "Ducimus nam enim ex consequatur cumque ratione.",
"state" : "closed",
"due_date" : null,
"iid" : 2,
"created_at" : "2016-01-04T15:31:39.996Z",
"title" : "v4.0",
"id" : 17,
"updated_at" : "2016-01-04T15:31:39.996Z"
},
"project_id" : 1,
2017-08-17 22:00:37 +05:30
"assignees" : [{
"state" : "active",
"id" : 1,
"name" : "Administrator",
"web_url" : "https://gitlab.example.com/root",
"avatar_url" : null,
"username" : "root"
}],
2016-04-02 18:10:28 +05:30
"assignee" : {
"state" : "active",
"id" : 1,
"name" : "Administrator",
2016-11-03 12:29:30 +05:30
"web_url" : "https://gitlab.example.com/root",
2016-04-02 18:10:28 +05:30
"avatar_url" : null,
"username" : "root"
},
"updated_at" : "2016-01-04T15:31:51.081Z",
2018-03-17 18:26:18 +05:30
"closed_at" : null,
2018-05-09 12:01:36 +05:30
"closed_by" : null,
2016-04-02 18:10:28 +05:30
"id" : 76,
"title" : "Consequatur vero maxime deserunt laboriosam est voluptas dolorem.",
"created_at" : "2016-01-04T15:31:51.081Z",
2020-01-01 13:55:28 +05:30
"moved_to_id" : null,
2016-04-02 18:10:28 +05:30
"iid" : 6,
2019-09-04 21:01:54 +05:30
"labels" : ["foo", "bar"],
2019-03-02 22:35:43 +05:30
"upvotes": 4,
"downvotes": 0,
2019-07-07 11:18:12 +05:30
"merge_requests_count": 0,
2016-08-24 12:49:21 +05:30
"user_notes_count": 1,
2016-09-29 09:46:39 +05:30
"due_date": "2016-07-22",
2020-03-13 15:44:24 +05:30
"web_url": "http://example.com/my-group/my-project/issues/6",
"references": {
"short": "#6",
"relative": "my-group/my-project#6",
"full": "my-group/my-project#6"
},
2018-03-17 18:26:18 +05:30
"time_stats": {
"time_estimate": 0,
"total_time_spent": 0,
"human_time_estimate": null,
"human_total_time_spent": null
},
2019-09-04 21:01:54 +05:30
"has_tasks": true,
"task_status": "10 of 15 tasks completed",
2018-03-17 18:26:18 +05:30
"confidential": false,
2019-09-04 21:01:54 +05:30
"discussion_locked": false,
"_links":{
"self":"http://example.com/api/v4/projects/1/issues/76",
"notes":"`http://example.com/`api/v4/projects/1/issues/76/notes",
"award_emoji":"http://example.com/api/v4/projects/1/issues/76/award_emoji",
"project":"http://example.com/api/v4/projects/1"
},
"task_completion_status":{
"count":0,
"completed_count":0
}
2016-08-24 12:49:21 +05:30
}
]
```
2019-09-30 21:07:59 +05:30
Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) will also see
the `weight` parameter:
```json
[
{
"state" : "opened",
"description" : "Ratione dolores corrupti mollitia soluta quia.",
"weight": null,
...
}
]
```
2017-08-17 22:00:37 +05:30
**Note**: `assignee` column is deprecated, now we show it as a single-sized array `assignees` to conform to the GitLab EE API.
2018-05-09 12:01:36 +05:30
**Note**: The `closed_by` attribute was [introduced in GitLab 10.6][ce-17042]. This value will only be present for issues which were closed after GitLab 10.6 and when the user account that closed the issue still exists.
2016-08-24 12:49:21 +05:30
## List group issues
Get a list of a group's issues.
2020-04-08 14:13:33 +05:30
```plaintext
2016-08-24 12:49:21 +05:30
GET /groups/:id/issues
GET /groups/:id/issues?state=opened
GET /groups/:id/issues?state=closed
GET /groups/:id/issues?labels=foo
GET /groups/:id/issues?labels=foo,bar
GET /groups/:id/issues?labels=foo,bar&state=opened
GET /groups/:id/issues?milestone=1.0.0
GET /groups/:id/issues?milestone=1.0.0&state=opened
2017-08-17 22:00:37 +05:30
GET /groups/:id/issues?iids[]=42&iids[]=43
GET /groups/:id/issues?search=issue+title+or+description
2017-09-10 17:25:29 +05:30
GET /groups/:id/issues?author_id=5
GET /groups/:id/issues?assignee_id=5
2018-03-17 18:26:18 +05:30
GET /groups/:id/issues?my_reaction_emoji=star
2019-07-07 11:18:12 +05:30
GET /groups/:id/issues?confidential=true
2016-08-24 12:49:21 +05:30
```
2018-03-17 18:26:18 +05:30
| Attribute | Type | Required | Description |
| ------------------- | ---------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user |
| `state` | string | no | Return all issues or just those that are `opened` or `closed` |
2019-02-15 15:39:39 +05:30
| `labels` | string | no | Comma-separated list of label names, issues must have all labels to be returned. `None` lists all issues with no labels. `Any` lists all issues with at least one label. `No+Label` (Deprecated) lists all issues with no labels. Predefined names are case-insensitive. |
2020-04-08 14:13:33 +05:30
| `with_labels_details` | boolean | no | If `true`, response will return more details for each label in labels field: `:name`, `:color`, `:description`, `:description_html`, `:text_color`. Default is `false`. The `description_html` attribute was introduced in [GitLab 12.7](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/21413) |
2019-09-30 21:07:59 +05:30
| `iids[]` | integer array | no | Return only the issues having the given `iid` |
2018-12-13 13:39:08 +05:30
| `milestone` | string | no | The milestone title. `None` lists all issues with no milestone. `Any` lists all issues that have an assigned milestone. |
2018-11-08 19:23:39 +05:30
| `scope` | string | no | Return issues for the given scope: `created_by_me`, `assigned_to_me` or `all`.<br> For versions before 11.0, use the now deprecated `created-by-me` or `assigned-to-me` scopes instead.<br> _([Introduced][ce-13004] in GitLab 9.5. [Changed to snake_case][ce-18935] in GitLab 11.0)_ |
2019-09-04 21:01:54 +05:30
| `author_id` | integer | no | Return issues created by the given user `id`. Mutually exclusive with `author_username`. Combine with `scope=all` or `scope=assigned_to_me`. _([Introduced][ce-13004] in GitLab 9.5)_ |
2019-09-30 21:07:59 +05:30
| `author_username` | string | no | Return issues created by the given `username`. Similar to `author_id` and mutually exclusive with `author_id`. |
2019-09-04 21:01:54 +05:30
| `assignee_id` | integer | no | Return issues assigned to the given user `id`. Mutually exclusive with `assignee_username`. `None` returns unassigned issues. `Any` returns issues with an assignee. _([Introduced][ce-13004] in GitLab 9.5)_ |
2019-09-30 21:07:59 +05:30
| `assignee_username` | string array | no | Return issues assigned to the given `username`. Similar to `assignee_id` and mutually exclusive with `assignee_id`. In CE version `assignee_username` array should only contain a single value or an invalid param error will be returned otherwise. |
2018-12-13 13:39:08 +05:30
| `my_reaction_emoji` | string | no | Return issues reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns issues given at least one reaction. _([Introduced][ce-14016] in GitLab 10.0)_ |
2019-09-30 21:07:59 +05:30
| `weight` **(STARTER)** | integer | no | Return issues with the specified `weight`. `None` returns issues with no weight assigned. `Any` returns issues with a weight assigned. |
2019-12-04 20:38:33 +05:30
| `order_by` | string | no | Return issues ordered by `created_at`, `updated_at`, `priority`, `due_date`, `relative_position`, `label_priority`, `milestone_due`, `popularity`, `weight` fields. Default is `created_at` |
2018-03-17 18:26:18 +05:30
| `sort` | string | no | Return issues sorted in `asc` or `desc` order. Default is `desc` |
| `search` | string | no | Search group issues against their `title` and `description` |
2018-03-27 19:54:05 +05:30
| `created_after` | datetime | no | Return issues created on or after the given time |
| `created_before` | datetime | no | Return issues created on or before the given time |
| `updated_after` | datetime | no | Return issues updated on or after the given time |
| `updated_before` | datetime | no | Return issues updated on or before the given time |
2020-04-08 14:13:33 +05:30
| `confidential` | boolean | no | Filter confidential or public issues. |
2019-12-21 20:55:43 +05:30
| `not` | Hash | no | Return issues that do not match the parameters supplied. Accepts: `labels`, `milestone`, `author_id`, `author_username`, `assignee_id`, `assignee_username`, `my_reaction_emoji`, `search`, `in` |
2020-04-08 14:13:33 +05:30
| `non_archived` | boolean | no | Return issues from non archived projects. Default is true. _(Introduced in [GitLab 12.8](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/23785))_ |
2016-08-24 12:49:21 +05:30
2020-03-13 15:44:24 +05:30
```shell
2019-02-15 15:39:39 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/4/issues
2016-08-24 12:49:21 +05:30
```
Example response:
```json
[
{
"project_id" : 4,
"milestone" : {
"due_date" : null,
"project_id" : 4,
"state" : "closed",
"description" : "Rerum est voluptatem provident consequuntur molestias similique ipsum dolor.",
"iid" : 3,
"id" : 11,
"title" : "v3.0",
"created_at" : "2016-01-04T15:31:39.788Z",
"updated_at" : "2016-01-04T15:31:39.788Z"
},
"author" : {
"state" : "active",
2016-11-03 12:29:30 +05:30
"web_url" : "https://gitlab.example.com/root",
2016-08-24 12:49:21 +05:30
"avatar_url" : null,
"username" : "root",
"id" : 1,
"name" : "Administrator"
},
"description" : "Omnis vero earum sunt corporis dolor et placeat.",
"state" : "closed",
"iid" : 1,
2017-08-17 22:00:37 +05:30
"assignees" : [{
"avatar_url" : null,
"web_url" : "https://gitlab.example.com/lennie",
"state" : "active",
"username" : "lennie",
"id" : 9,
"name" : "Dr. Luella Kovacek"
}],
2016-08-24 12:49:21 +05:30
"assignee" : {
"avatar_url" : null,
2016-11-03 12:29:30 +05:30
"web_url" : "https://gitlab.example.com/lennie",
2016-08-24 12:49:21 +05:30
"state" : "active",
"username" : "lennie",
"id" : 9,
"name" : "Dr. Luella Kovacek"
},
2019-09-04 21:01:54 +05:30
"labels" : ["foo", "bar"],
2019-03-02 22:35:43 +05:30
"upvotes": 4,
"downvotes": 0,
2019-07-07 11:18:12 +05:30
"merge_requests_count": 0,
2016-08-24 12:49:21 +05:30
"id" : 41,
"title" : "Ut commodi ullam eos dolores perferendis nihil sunt.",
"updated_at" : "2016-01-04T15:31:46.176Z",
"created_at" : "2016-01-04T15:31:46.176Z",
2018-03-17 18:26:18 +05:30
"closed_at" : null,
2018-05-09 12:01:36 +05:30
"closed_by" : null,
2016-08-24 12:49:21 +05:30
"user_notes_count": 1,
2016-09-29 09:46:39 +05:30
"due_date": null,
2020-03-13 15:44:24 +05:30
"web_url": "http://example.com/my-group/my-project/issues/1",
"references": {
"short": "#1",
"relative": "my-project#1",
"full": "my-group/my-project#1"
},
2018-03-17 18:26:18 +05:30
"time_stats": {
"time_estimate": 0,
"total_time_spent": 0,
"human_time_estimate": null,
"human_total_time_spent": null
},
2019-09-04 21:01:54 +05:30
"has_tasks": true,
"task_status": "10 of 15 tasks completed",
2018-03-17 18:26:18 +05:30
"confidential": false,
2019-09-04 21:01:54 +05:30
"discussion_locked": false,
"_links":{
"self":"http://example.com/api/v4/projects/4/issues/41",
"notes":"`http://example.com/`api/v4/projects/4/issues/41/notes",
"award_emoji":"http://example.com/api/v4/projects/4/issues/41/award_emoji",
"project":"http://example.com/api/v4/projects/4"
},
"task_completion_status":{
"count":0,
"completed_count":0
}
2016-06-02 11:05:42 +05:30
}
2014-09-02 18:07:02 +05:30
]
```
2019-09-30 21:07:59 +05:30
Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) will also see
the `weight` parameter:
```json
[
{
"project_id" : 4,
"description" : "Omnis vero earum sunt corporis dolor et placeat.",
"weight": null,
...
}
]
```
2017-08-17 22:00:37 +05:30
**Note**: `assignee` column is deprecated, now we show it as a single-sized array `assignees` to conform to the GitLab EE API.
2018-05-09 12:01:36 +05:30
**Note**: The `closed_by` attribute was [introduced in GitLab 10.6][ce-17042]. This value will only be present for issues which were closed after GitLab 10.6 and when the user account that closed the issue still exists.
2014-09-02 18:07:02 +05:30
## List project issues
2016-04-02 18:10:28 +05:30
Get a list of a project's issues.
2014-09-02 18:07:02 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2014-09-02 18:07:02 +05:30
GET /projects/:id/issues
2015-04-26 12:48:37 +05:30
GET /projects/:id/issues?state=opened
GET /projects/:id/issues?state=closed
GET /projects/:id/issues?labels=foo
GET /projects/:id/issues?labels=foo,bar
GET /projects/:id/issues?labels=foo,bar&state=opened
GET /projects/:id/issues?milestone=1.0.0
GET /projects/:id/issues?milestone=1.0.0&state=opened
2017-08-17 22:00:37 +05:30
GET /projects/:id/issues?iids[]=42&iids[]=43
GET /projects/:id/issues?search=issue+title+or+description
2017-09-10 17:25:29 +05:30
GET /projects/:id/issues?author_id=5
GET /projects/:id/issues?assignee_id=5
2018-03-17 18:26:18 +05:30
GET /projects/:id/issues?my_reaction_emoji=star
2019-07-07 11:18:12 +05:30
GET /projects/:id/issues?confidential=true
2018-03-17 18:26:18 +05:30
```
| Attribute | Type | Required | Description |
| ------------------- | ---------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
2019-09-30 21:07:59 +05:30
| `iids[]` | integer array | no | Return only the milestone having the given `iid` |
2018-03-17 18:26:18 +05:30
| `state` | string | no | Return all issues or just those that are `opened` or `closed` |
2019-02-15 15:39:39 +05:30
| `labels` | string | no | Comma-separated list of label names, issues must have all labels to be returned. `None` lists all issues with no labels. `Any` lists all issues with at least one label. `No+Label` (Deprecated) lists all issues with no labels. Predefined names are case-insensitive. |
2020-04-08 14:13:33 +05:30
| `with_labels_details` | boolean | no | If `true`, response will return more details for each label in labels field: `:name`, `:color`, `:description`, `:description_html`, `:text_color`. Default is `false`. `description_html` Introduced in [GitLab 12.7](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/21413) |
2018-12-13 13:39:08 +05:30
| `milestone` | string | no | The milestone title. `None` lists all issues with no milestone. `Any` lists all issues that have an assigned milestone. |
2018-11-08 19:23:39 +05:30
| `scope` | string | no | Return issues for the given scope: `created_by_me`, `assigned_to_me` or `all`.<br> For versions before 11.0, use the now deprecated `created-by-me` or `assigned-to-me` scopes instead.<br> _([Introduced][ce-13004] in GitLab 9.5. [Changed to snake_case][ce-18935] in GitLab 11.0)_ |
2019-09-04 21:01:54 +05:30
| `author_id` | integer | no | Return issues created by the given user `id`. Mutually exclusive with `author_username`. Combine with `scope=all` or `scope=assigned_to_me`. _([Introduced][ce-13004] in GitLab 9.5)_ |
2019-09-30 21:07:59 +05:30
| `author_username` | string | no | Return issues created by the given `username`. Similar to `author_id` and mutually exclusive with `author_id`. |
2019-09-04 21:01:54 +05:30
| `assignee_id` | integer | no | Return issues assigned to the given user `id`. Mutually exclusive with `assignee_username`. `None` returns unassigned issues. `Any` returns issues with an assignee. _([Introduced][ce-13004] in GitLab 9.5)_ |
2019-09-30 21:07:59 +05:30
| `assignee_username` | string array | no | Return issues assigned to the given `username`. Similar to `assignee_id` and mutually exclusive with `assignee_id`. In CE version `assignee_username` array should only contain a single value or an invalid param error will be returned otherwise. |
2018-12-13 13:39:08 +05:30
| `my_reaction_emoji` | string | no | Return issues reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns issues given at least one reaction. _([Introduced][ce-14016] in GitLab 10.0)_ |
2019-09-30 21:07:59 +05:30
| `weight` **(STARTER)** | integer | no | Return issues with the specified `weight`. `None` returns issues with no weight assigned. `Any` returns issues with a weight assigned. |
2019-12-04 20:38:33 +05:30
| `order_by` | string | no | Return issues ordered by `created_at`, `updated_at`, `priority`, `due_date`, `relative_position`, `label_priority`, `milestone_due`, `popularity`, `weight` fields. Default is `created_at` |
2018-03-17 18:26:18 +05:30
| `sort` | string | no | Return issues sorted in `asc` or `desc` order. Default is `desc` |
| `search` | string | no | Search project issues against their `title` and `description` |
2018-03-27 19:54:05 +05:30
| `created_after` | datetime | no | Return issues created on or after the given time |
| `created_before` | datetime | no | Return issues created on or before the given time |
| `updated_after` | datetime | no | Return issues updated on or after the given time |
| `updated_before` | datetime | no | Return issues updated on or before the given time |
2020-04-08 14:13:33 +05:30
| `confidential` | boolean | no | Filter confidential or public issues. |
2019-12-04 20:38:33 +05:30
| `not` | Hash | no | Return issues that do not match the parameters supplied. Accepts: `labels`, `milestone`, `author_id`, `author_username`, `assignee_id`, `assignee_username`, `my_reaction_emoji`, `search`, `in` |
2016-04-02 18:10:28 +05:30
2020-03-13 15:44:24 +05:30
```shell
2019-02-15 15:39:39 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/4/issues
2016-04-02 18:10:28 +05:30
```
Example response:
2014-09-02 18:07:02 +05:30
2016-04-02 18:10:28 +05:30
```json
[
{
"project_id" : 4,
"milestone" : {
"due_date" : null,
"project_id" : 4,
"state" : "closed",
"description" : "Rerum est voluptatem provident consequuntur molestias similique ipsum dolor.",
"iid" : 3,
"id" : 11,
"title" : "v3.0",
"created_at" : "2016-01-04T15:31:39.788Z",
"updated_at" : "2016-01-04T15:31:39.788Z"
},
"author" : {
"state" : "active",
2016-11-03 12:29:30 +05:30
"web_url" : "https://gitlab.example.com/root",
2016-04-02 18:10:28 +05:30
"avatar_url" : null,
"username" : "root",
"id" : 1,
"name" : "Administrator"
},
"description" : "Omnis vero earum sunt corporis dolor et placeat.",
"state" : "closed",
"iid" : 1,
2017-08-17 22:00:37 +05:30
"assignees" : [{
"avatar_url" : null,
"web_url" : "https://gitlab.example.com/lennie",
"state" : "active",
"username" : "lennie",
"id" : 9,
"name" : "Dr. Luella Kovacek"
}],
2016-04-02 18:10:28 +05:30
"assignee" : {
"avatar_url" : null,
2016-11-03 12:29:30 +05:30
"web_url" : "https://gitlab.example.com/lennie",
2016-04-02 18:10:28 +05:30
"state" : "active",
"username" : "lennie",
"id" : 9,
"name" : "Dr. Luella Kovacek"
},
2019-09-04 21:01:54 +05:30
"labels" : ["foo", "bar"],
2019-03-02 22:35:43 +05:30
"upvotes": 4,
"downvotes": 0,
2019-07-07 11:18:12 +05:30
"merge_requests_count": 0,
2016-04-02 18:10:28 +05:30
"id" : 41,
"title" : "Ut commodi ullam eos dolores perferendis nihil sunt.",
"updated_at" : "2016-01-04T15:31:46.176Z",
2016-06-02 11:05:42 +05:30
"created_at" : "2016-01-04T15:31:46.176Z",
2018-03-17 18:26:18 +05:30
"closed_at" : "2016-01-05T15:31:46.176Z",
2018-05-09 12:01:36 +05:30
"closed_by" : {
"state" : "active",
"web_url" : "https://gitlab.example.com/root",
"avatar_url" : null,
"username" : "root",
"id" : 1,
"name" : "Administrator"
},
2016-08-24 12:49:21 +05:30
"user_notes_count": 1,
2016-09-29 09:46:39 +05:30
"due_date": "2016-07-22",
2020-03-13 15:44:24 +05:30
"web_url": "http://example.com/my-group/my-project/issues/1",
"references": {
"short": "#1",
"relative": "#1",
"full": "my-group/my-project#1"
},
2018-03-17 18:26:18 +05:30
"time_stats": {
"time_estimate": 0,
"total_time_spent": 0,
"human_time_estimate": null,
"human_total_time_spent": null
},
2019-09-04 21:01:54 +05:30
"has_tasks": true,
"task_status": "10 of 15 tasks completed",
2018-03-17 18:26:18 +05:30
"confidential": false,
2019-09-04 21:01:54 +05:30
"discussion_locked": false,
"_links":{
"self":"http://example.com/api/v4/projects/4/issues/41",
"notes":"`http://example.com/`api/v4/projects/4/issues/41/notes",
"award_emoji":"http://example.com/api/v4/projects/4/issues/41/award_emoji",
"project":"http://example.com/api/v4/projects/4"
},
"task_completion_status":{
"count":0,
"completed_count":0
}
2016-04-02 18:10:28 +05:30
}
]
```
2014-09-02 18:07:02 +05:30
2019-09-30 21:07:59 +05:30
Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) will also see
the `weight` parameter:
```json
[
{
"project_id" : 4,
"description" : "Omnis vero earum sunt corporis dolor et placeat.",
"weight": null,
...
}
]
```
2017-08-17 22:00:37 +05:30
**Note**: `assignee` column is deprecated, now we show it as a single-sized array `assignees` to conform to the GitLab EE API.
2018-05-09 12:01:36 +05:30
**Note**: The `closed_by` attribute was [introduced in GitLab 10.6][ce-17042]. This value will only be present for issues which were closed after GitLab 10.6 and when the user account that closed the issue still exists.
2014-09-02 18:07:02 +05:30
## Single issue
2016-04-02 18:10:28 +05:30
Get a single project issue.
2014-09-02 18:07:02 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2017-08-17 22:00:37 +05:30
GET /projects/:id/issues/:issue_iid
2014-09-02 18:07:02 +05:30
```
2017-08-17 22:00:37 +05:30
| Attribute | Type | Required | Description |
|-------------|---------|----------|--------------------------------------|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `issue_iid` | integer | yes | The internal ID of a project's issue |
2014-09-02 18:07:02 +05:30
2020-03-13 15:44:24 +05:30
```shell
2019-02-15 15:39:39 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/4/issues/41
2016-04-02 18:10:28 +05:30
```
Example response:
2014-09-02 18:07:02 +05:30
```json
{
2016-04-02 18:10:28 +05:30
"project_id" : 4,
"milestone" : {
"due_date" : null,
"project_id" : 4,
"state" : "closed",
"description" : "Rerum est voluptatem provident consequuntur molestias similique ipsum dolor.",
"iid" : 3,
"id" : 11,
"title" : "v3.0",
"created_at" : "2016-01-04T15:31:39.788Z",
2018-03-17 18:26:18 +05:30
"updated_at" : "2016-01-04T15:31:39.788Z",
"closed_at" : "2016-01-05T15:31:46.176Z"
2016-04-02 18:10:28 +05:30
},
"author" : {
"state" : "active",
2016-11-03 12:29:30 +05:30
"web_url" : "https://gitlab.example.com/root",
2016-04-02 18:10:28 +05:30
"avatar_url" : null,
"username" : "root",
"id" : 1,
"name" : "Administrator"
},
"description" : "Omnis vero earum sunt corporis dolor et placeat.",
"state" : "closed",
"iid" : 1,
2017-08-17 22:00:37 +05:30
"assignees" : [{
"avatar_url" : null,
"web_url" : "https://gitlab.example.com/lennie",
"state" : "active",
"username" : "lennie",
"id" : 9,
"name" : "Dr. Luella Kovacek"
}],
2016-04-02 18:10:28 +05:30
"assignee" : {
"avatar_url" : null,
2016-11-03 12:29:30 +05:30
"web_url" : "https://gitlab.example.com/lennie",
2016-04-02 18:10:28 +05:30
"state" : "active",
"username" : "lennie",
"id" : 9,
"name" : "Dr. Luella Kovacek"
},
"labels" : [],
2019-03-02 22:35:43 +05:30
"upvotes": 4,
"downvotes": 0,
2019-07-07 11:18:12 +05:30
"merge_requests_count": 0,
2016-04-02 18:10:28 +05:30
"id" : 41,
"title" : "Ut commodi ullam eos dolores perferendis nihil sunt.",
"updated_at" : "2016-01-04T15:31:46.176Z",
2016-06-02 11:05:42 +05:30
"created_at" : "2016-01-04T15:31:46.176Z",
2018-05-09 12:01:36 +05:30
"closed_at" : null,
"closed_by" : null,
2016-06-02 11:05:42 +05:30
"subscribed": false,
2016-08-24 12:49:21 +05:30
"user_notes_count": 1,
2016-09-29 09:46:39 +05:30
"due_date": null,
2020-03-13 15:44:24 +05:30
"web_url": "http://example.com/my-group/my-project/issues/1",
"references": {
"short": "#1",
"relative": "#1",
"full": "my-group/my-project#1"
},
2018-03-17 18:26:18 +05:30
"time_stats": {
"time_estimate": 0,
"total_time_spent": 0,
"human_time_estimate": null,
"human_total_time_spent": null
},
2017-09-10 17:25:29 +05:30
"confidential": false,
2018-03-17 18:26:18 +05:30
"discussion_locked": false,
2017-09-10 17:25:29 +05:30
"_links": {
"self": "http://example.com/api/v4/projects/1/issues/2",
"notes": "http://example.com/api/v4/projects/1/issues/2/notes",
"award_emoji": "http://example.com/api/v4/projects/1/issues/2/award_emoji",
"project": "http://example.com/api/v4/projects/1"
2019-09-04 21:01:54 +05:30
},
"task_completion_status":{
"count":0,
"completed_count":0
2017-09-10 17:25:29 +05:30
}
2014-09-02 18:07:02 +05:30
}
```
2019-09-30 21:07:59 +05:30
Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) will also see
the `weight` parameter:
```json
{
"project_id" : 4,
"description" : "Omnis vero earum sunt corporis dolor et placeat.",
"weight": null,
...
}
```
2019-12-04 20:38:33 +05:30
Users on GitLab [Ultimate](https://about.gitlab.com/pricing/) will additionally see
2019-12-26 22:10:19 +05:30
the `epic` property:
2019-12-04 20:38:33 +05:30
2019-12-26 22:10:19 +05:30
```javascript
2019-12-04 20:38:33 +05:30
{
"project_id" : 4,
"description" : "Omnis vero earum sunt corporis dolor et placeat.",
2019-12-26 22:10:19 +05:30
"epic": {
"epic_iid" : 5, //deprecated, use `iid` of the `epic` attribute
"epic": {
"id" : 42,
"iid" : 5,
"title": "My epic epic",
"url" : "/groups/h5bp/-/epics/5",
"group_id": 8
},
// ...
2019-12-04 20:38:33 +05:30
}
```
2017-08-17 22:00:37 +05:30
**Note**: `assignee` column is deprecated, now we show it as a single-sized array `assignees` to conform to the GitLab EE API.
2018-05-09 12:01:36 +05:30
**Note**: The `closed_by` attribute was [introduced in GitLab 10.6][ce-17042]. This value will only be present for issues which were closed after GitLab 10.6 and when the user account that closed the issue still exists.
2019-12-26 22:10:19 +05:30
**Note**: The `epic_iid` attribute is deprecated and [will be removed in 13.0](https://gitlab.com/gitlab-org/gitlab/issues/35157).
Please use `iid` of the `epic` attribute instead.
2014-09-02 18:07:02 +05:30
## New issue
Creates a new project issue.
2020-04-08 14:13:33 +05:30
```plaintext
2014-09-02 18:07:02 +05:30
POST /projects/:id/issues
```
2017-08-17 22:00:37 +05:30
| Attribute | Type | Required | Description |
|-------------------------------------------|----------------|----------|--------------|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
2018-11-18 11:00:15 +05:30
| `iid` | integer/string | no | The internal ID of the project's issue (requires admin or project owner rights) |
2019-09-30 21:07:59 +05:30
| `title` | string | yes | The title of an issue |
2019-12-21 20:55:43 +05:30
| `description` | string | no | The description of an issue. Limited to 1,048,576 characters. |
2019-09-30 21:07:59 +05:30
| `confidential` | boolean | no | Set an issue to be confidential. Default is `false`. |
| `assignee_ids` | integer array | no | The ID of a user to assign issue |
| `milestone_id` | integer | no | The global ID of a milestone to assign issue |
| `labels` | string | no | Comma-separated label names for an issue |
| `created_at` | string | no | Date time string, ISO 8601 formatted, e.g. `2016-03-11T03:45:40Z` (requires admin or project/group owner rights) |
| `due_date` | string | no | Date time string in the format YEAR-MONTH-DAY, e.g. `2016-03-11` |
| `merge_request_to_resolve_discussions_of` | integer | no | The IID of a merge request in which to resolve all issues. This will fill the issue with a default description and mark all discussions as resolved. When passing a description or title, these values will take precedence over the default values.|
| `discussion_to_resolve` | string | no | The ID of a discussion to resolve. This will fill in the issue with a default description and mark the discussion as resolved. Use in combination with `merge_request_to_resolve_discussions_of`. |
| `weight` **(STARTER)** | integer | no | The weight of the issue. Valid values are greater than or equal to 0. |
2020-01-01 13:55:28 +05:30
| `epic_id` **(ULTIMATE)** | integer | no | ID of the epic to add the issue to. Valid values are greater than or equal to 0. |
| `epic_iid` **(ULTIMATE)** | integer | no | IID of the epic to add the issue to. Valid values are greater than or equal to 0. (deprecated, [will be removed in 13.0](https://gitlab.com/gitlab-org/gitlab/issues/35157)) |
2016-04-02 18:10:28 +05:30
2020-03-13 15:44:24 +05:30
```shell
2019-02-15 15:39:39 +05:30
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/4/issues?title=Issues%20with%20auth&labels=bug
2016-04-02 18:10:28 +05:30
```
2014-09-02 18:07:02 +05:30
2016-04-02 18:10:28 +05:30
Example response:
2014-09-02 18:07:02 +05:30
2016-04-02 18:10:28 +05:30
```json
{
"project_id" : 4,
"id" : 84,
"created_at" : "2016-01-07T12:44:33.959Z",
"iid" : 14,
"title" : "Issues with auth",
"state" : "opened",
2017-08-17 22:00:37 +05:30
"assignees" : [],
2016-04-02 18:10:28 +05:30
"assignee" : null,
"labels" : [
"bug"
],
2019-03-02 22:35:43 +05:30
"upvotes": 4,
"downvotes": 0,
2019-07-07 11:18:12 +05:30
"merge_requests_count": 0,
2016-04-02 18:10:28 +05:30
"author" : {
"name" : "Alexandra Bashirian",
"avatar_url" : null,
"state" : "active",
2016-11-03 12:29:30 +05:30
"web_url" : "https://gitlab.example.com/eileen.lowe",
2016-04-02 18:10:28 +05:30
"id" : 18,
"username" : "eileen.lowe"
},
"description" : null,
"updated_at" : "2016-01-07T12:44:33.959Z",
2018-03-17 18:26:18 +05:30
"closed_at" : null,
2018-05-09 12:01:36 +05:30
"closed_by" : null,
2016-06-02 11:05:42 +05:30
"milestone" : null,
"subscribed" : true,
2016-08-24 12:49:21 +05:30
"user_notes_count": 0,
2016-09-29 09:46:39 +05:30
"due_date": null,
2020-03-13 15:44:24 +05:30
"web_url": "http://example.com/my-group/my-project/issues/14",
"references": {
"short": "#14",
"relative": "#14",
"full": "my-group/my-project#14"
},
2018-03-17 18:26:18 +05:30
"time_stats": {
"time_estimate": 0,
"total_time_spent": 0,
"human_time_estimate": null,
"human_total_time_spent": null
},
2017-09-10 17:25:29 +05:30
"confidential": false,
2018-03-17 18:26:18 +05:30
"discussion_locked": false,
2017-09-10 17:25:29 +05:30
"_links": {
"self": "http://example.com/api/v4/projects/1/issues/2",
"notes": "http://example.com/api/v4/projects/1/issues/2/notes",
"award_emoji": "http://example.com/api/v4/projects/1/issues/2/award_emoji",
"project": "http://example.com/api/v4/projects/1"
2019-09-04 21:01:54 +05:30
},
"task_completion_status":{
"count":0,
"completed_count":0
2017-09-10 17:25:29 +05:30
}
2016-04-02 18:10:28 +05:30
}
```
2014-09-02 18:07:02 +05:30
2019-09-30 21:07:59 +05:30
Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) will also see
the `weight` parameter:
```json
{
"project_id" : 4,
"description" : null,
"weight": null,
...
}
```
2017-08-17 22:00:37 +05:30
**Note**: `assignee` column is deprecated, now we show it as a single-sized array `assignees` to conform to the GitLab EE API.
2018-05-09 12:01:36 +05:30
**Note**: The `closed_by` attribute was [introduced in GitLab 10.6][ce-17042]. This value will only be present for issues which were closed after GitLab 10.6 and when the user account that closed the issue still exists.
2014-09-02 18:07:02 +05:30
## Edit issue
2016-04-02 18:10:28 +05:30
Updates an existing project issue. This call is also used to mark an issue as
closed.
2020-04-08 14:13:33 +05:30
```plaintext
2017-08-17 22:00:37 +05:30
PUT /projects/:id/issues/:issue_iid
2014-09-02 18:07:02 +05:30
```
2017-08-17 22:00:37 +05:30
| Attribute | Type | Required | Description |
|----------------|---------|----------|------------------------------------------------------------------------------------------------------------|
2019-09-30 21:07:59 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
2017-08-17 22:00:37 +05:30
| `issue_iid` | integer | yes | The internal ID of a project's issue |
| `title` | string | no | The title of an issue |
2019-12-21 20:55:43 +05:30
| `description` | string | no | The description of an issue. Limited to 1,048,576 characters. |
2017-08-17 22:00:37 +05:30
| `confidential` | boolean | no | Updates an issue to be confidential |
2019-09-30 21:07:59 +05:30
| `assignee_ids` | integer array | no | The ID of the user(s) to assign the issue to. Set to `0` or provide an empty value to unassign all assignees. |
2018-11-08 19:23:39 +05:30
| `milestone_id` | integer | no | The global ID of a milestone to assign the issue to. Set to `0` or provide an empty value to unassign a milestone.|
2018-03-17 18:26:18 +05:30
| `labels` | string | no | Comma-separated label names for an issue. Set to an empty string to unassign all labels. |
2017-08-17 22:00:37 +05:30
| `state_event` | string | no | The state event of an issue. Set `close` to close the issue and `reopen` to reopen it |
2020-04-08 14:13:33 +05:30
| `updated_at` | string | no | Date time string, ISO 8601 formatted, e.g. `2016-03-11T03:45:40Z` (requires admin or project owner rights). Empty string or null values are not accepted.|
2017-08-17 22:00:37 +05:30
| `due_date` | string | no | Date time string in the format YEAR-MONTH-DAY, e.g. `2016-03-11` |
2019-09-30 21:07:59 +05:30
| `weight` **(STARTER)** | integer | no | The weight of the issue. Valid values are greater than or equal to 0. 0 |
2018-03-17 18:26:18 +05:30
| `discussion_locked` | boolean | no | Flag indicating if the issue's discussion is locked. If the discussion is locked only project members can add or edit comments. |
2020-01-01 13:55:28 +05:30
| `epic_id` **(ULTIMATE)** | integer | no | ID of the epic to add the issue to. Valid values are greater than or equal to 0. |
| `epic_iid` **(ULTIMATE)** | integer | no | IID of the epic to add the issue to. Valid values are greater than or equal to 0. (deprecated, [will be removed in 13.0](https://gitlab.com/gitlab-org/gitlab/issues/35157)) |
2018-03-17 18:26:18 +05:30
2020-03-13 15:44:24 +05:30
```shell
2019-02-15 15:39:39 +05:30
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/4/issues/85?state_event=close
2016-04-02 18:10:28 +05:30
```
2014-09-02 18:07:02 +05:30
2016-04-02 18:10:28 +05:30
Example response:
2014-09-02 18:07:02 +05:30
2016-04-02 18:10:28 +05:30
```json
{
"created_at" : "2016-01-07T12:46:01.410Z",
"author" : {
"name" : "Alexandra Bashirian",
"avatar_url" : null,
"username" : "eileen.lowe",
"id" : 18,
"state" : "active",
2016-11-03 12:29:30 +05:30
"web_url" : "https://gitlab.example.com/eileen.lowe"
2016-04-02 18:10:28 +05:30
},
"state" : "closed",
"title" : "Issues with auth",
"project_id" : 4,
"description" : null,
"updated_at" : "2016-01-07T12:55:16.213Z",
2018-03-17 18:26:18 +05:30
"closed_at" : "2016-01-08T12:55:16.213Z",
2018-05-09 12:01:36 +05:30
"closed_by" : {
"state" : "active",
"web_url" : "https://gitlab.example.com/root",
"avatar_url" : null,
"username" : "root",
"id" : 1,
"name" : "Administrator"
},
2016-04-02 18:10:28 +05:30
"iid" : 15,
"labels" : [
"bug"
],
2019-03-02 22:35:43 +05:30
"upvotes": 4,
"downvotes": 0,
2019-07-07 11:18:12 +05:30
"merge_requests_count": 0,
2016-04-02 18:10:28 +05:30
"id" : 85,
2017-08-17 22:00:37 +05:30
"assignees" : [],
2016-04-02 18:10:28 +05:30
"assignee" : null,
2016-06-02 11:05:42 +05:30
"milestone" : null,
"subscribed" : true,
2016-08-24 12:49:21 +05:30
"user_notes_count": 0,
2016-09-29 09:46:39 +05:30
"due_date": "2016-07-22",
2020-03-13 15:44:24 +05:30
"web_url": "http://example.com/my-group/my-project/issues/15",
"references": {
"short": "#15",
"relative": "#15",
"full": "my-group/my-project#15"
},
2018-03-17 18:26:18 +05:30
"time_stats": {
"time_estimate": 0,
"total_time_spent": 0,
"human_time_estimate": null,
"human_total_time_spent": null
},
2017-09-10 17:25:29 +05:30
"confidential": false,
2018-03-17 18:26:18 +05:30
"discussion_locked": false,
2017-09-10 17:25:29 +05:30
"_links": {
"self": "http://example.com/api/v4/projects/1/issues/2",
"notes": "http://example.com/api/v4/projects/1/issues/2/notes",
"award_emoji": "http://example.com/api/v4/projects/1/issues/2/award_emoji",
"project": "http://example.com/api/v4/projects/1"
2019-09-04 21:01:54 +05:30
},
"task_completion_status":{
"count":0,
"completed_count":0
2017-09-10 17:25:29 +05:30
}
2016-04-02 18:10:28 +05:30
}
```
2014-09-02 18:07:02 +05:30
2019-09-30 21:07:59 +05:30
Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) will also see
the `weight` parameter:
```json
{
"project_id" : 4,
"description" : null,
"weight": null,
...
}
```
2020-04-08 14:13:33 +05:30
NOTE: **Note:**
At least one of following parameters is required to be passed for the request to be successful: `:assignee_id`, `:assignee_ids`, `:confidential`, `:created_at`, `:description`, `:discussion_locked`, `:due_date`, `:labels`, `:milestone_id`, `:state_event`, or `:title`.
2017-08-17 22:00:37 +05:30
2020-04-08 14:13:33 +05:30
NOTE: **Note**:
`assignee` column is deprecated. We now show it as a single-sized array `assignees` to conform to the GitLab EE API.
NOTE: **Note**:
The `closed_by` attribute was [introduced in GitLab 10.6][ce-17042]. This value will only be present for issues which were closed after GitLab 10.6 and when the user account that closed the issue still exists.
2018-05-09 12:01:36 +05:30
2016-06-02 11:05:42 +05:30
## Delete an issue
2014-09-02 18:07:02 +05:30
2019-12-04 20:38:33 +05:30
Only for admins and project owners. Deletes the issue in question.
2014-09-02 18:07:02 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2017-08-17 22:00:37 +05:30
DELETE /projects/:id/issues/:issue_iid
2014-09-02 18:07:02 +05:30
```
2017-08-17 22:00:37 +05:30
| Attribute | Type | Required | Description |
|-------------|---------|----------|--------------------------------------|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `issue_iid` | integer | yes | The internal ID of a project's issue |
2016-06-02 11:05:42 +05:30
2020-03-13 15:44:24 +05:30
```shell
2019-02-15 15:39:39 +05:30
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/4/issues/85
2016-06-02 11:05:42 +05:30
```
## Move an issue
2017-08-17 22:00:37 +05:30
Moves an issue to a different project. If the target project
2016-06-02 11:05:42 +05:30
equals the source project or the user has insufficient permissions to move an
issue, error `400` together with an explaining error message is returned.
If a given label and/or milestone with the same name also exists in the target
project, it will then be assigned to the issue that is being moved.
2020-04-08 14:13:33 +05:30
```plaintext
2017-08-17 22:00:37 +05:30
POST /projects/:id/issues/:issue_iid/move
2016-06-02 11:05:42 +05:30
```
2017-08-17 22:00:37 +05:30
| Attribute | Type | Required | Description |
|-----------------|---------|----------|--------------------------------------|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `issue_iid` | integer | yes | The internal ID of a project's issue |
| `to_project_id` | integer | yes | The ID of the new project |
2016-06-02 11:05:42 +05:30
2020-03-13 15:44:24 +05:30
```shell
2019-02-15 15:39:39 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" --form to_project_id=5 https://gitlab.example.com/api/v4/projects/4/issues/85/move
2016-06-02 11:05:42 +05:30
```
Example response:
```json
{
"id": 92,
"iid": 11,
"project_id": 5,
"title": "Sit voluptas tempora quisquam aut doloribus et.",
"description": "Repellat voluptas quibusdam voluptatem exercitationem.",
"state": "opened",
"created_at": "2016-04-05T21:41:45.652Z",
"updated_at": "2016-04-07T12:20:17.596Z",
2018-03-17 18:26:18 +05:30
"closed_at": null,
2018-05-09 12:01:36 +05:30
"closed_by": null,
2016-06-02 11:05:42 +05:30
"labels": [],
2019-03-02 22:35:43 +05:30
"upvotes": 4,
"downvotes": 0,
2019-07-07 11:18:12 +05:30
"merge_requests_count": 0,
2016-06-02 11:05:42 +05:30
"milestone": null,
2017-08-17 22:00:37 +05:30
"assignees": [{
"name": "Miss Monserrate Beier",
"username": "axel.block",
"id": 12,
"state": "active",
"avatar_url": "http://www.gravatar.com/avatar/46f6f7dc858ada7be1853f7fb96e81da?s=80&d=identicon",
"web_url": "https://gitlab.example.com/axel.block"
}],
2016-06-02 11:05:42 +05:30
"assignee": {
"name": "Miss Monserrate Beier",
"username": "axel.block",
"id": 12,
"state": "active",
"avatar_url": "http://www.gravatar.com/avatar/46f6f7dc858ada7be1853f7fb96e81da?s=80&d=identicon",
2016-11-03 12:29:30 +05:30
"web_url": "https://gitlab.example.com/axel.block"
2016-06-02 11:05:42 +05:30
},
"author": {
"name": "Kris Steuber",
"username": "solon.cremin",
"id": 10,
"state": "active",
"avatar_url": "http://www.gravatar.com/avatar/7a190fecbaa68212a4b68aeb6e3acd10?s=80&d=identicon",
2016-11-03 12:29:30 +05:30
"web_url": "https://gitlab.example.com/solon.cremin"
2016-08-24 12:49:21 +05:30
},
2016-09-29 09:46:39 +05:30
"due_date": null,
2020-03-13 15:44:24 +05:30
"web_url": "http://example.com/my-group/my-project/issues/11",
"references": {
"short": "#11",
"relative": "#11",
"full": "my-group/my-project#11"
},
2018-03-17 18:26:18 +05:30
"time_stats": {
"time_estimate": 0,
"total_time_spent": 0,
"human_time_estimate": null,
"human_total_time_spent": null
},
2017-09-10 17:25:29 +05:30
"confidential": false,
2018-03-17 18:26:18 +05:30
"discussion_locked": false,
2017-09-10 17:25:29 +05:30
"_links": {
"self": "http://example.com/api/v4/projects/1/issues/2",
"notes": "http://example.com/api/v4/projects/1/issues/2/notes",
"award_emoji": "http://example.com/api/v4/projects/1/issues/2/award_emoji",
"project": "http://example.com/api/v4/projects/1"
2019-09-04 21:01:54 +05:30
},
"task_completion_status":{
"count":0,
"completed_count":0
2017-09-10 17:25:29 +05:30
}
2016-06-02 11:05:42 +05:30
}
```
2019-09-30 21:07:59 +05:30
Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) will also see
the `weight` parameter:
```json
{
"project_id": 5,
"description": "Repellat voluptas quibusdam voluptatem exercitationem.",
"weight": null,
...
}
```
2017-08-17 22:00:37 +05:30
**Note**: `assignee` column is deprecated, now we show it as a single-sized array `assignees` to conform to the GitLab EE API.
2018-05-09 12:01:36 +05:30
**Note**: The `closed_by` attribute was [introduced in GitLab 10.6][ce-17042]. This value will only be present for issues which were closed after GitLab 10.6 and when the user account that closed the issue still exists.
2016-06-02 11:05:42 +05:30
## Subscribe to an issue
2017-08-17 22:00:37 +05:30
Subscribes the authenticated user to an issue to receive notifications.
If the user is already subscribed to the issue, the status code `304`
is returned.
2016-06-02 11:05:42 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2017-08-17 22:00:37 +05:30
POST /projects/:id/issues/:issue_iid/subscribe
2016-06-02 11:05:42 +05:30
```
2017-08-17 22:00:37 +05:30
| Attribute | Type | Required | Description |
|-------------|---------|----------|--------------------------------------|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `issue_iid` | integer | yes | The internal ID of a project's issue |
2016-06-02 11:05:42 +05:30
2020-03-13 15:44:24 +05:30
```shell
2019-02-15 15:39:39 +05:30
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/issues/93/subscribe
2016-06-02 11:05:42 +05:30
```
Example response:
```json
{
"id": 92,
"iid": 11,
"project_id": 5,
"title": "Sit voluptas tempora quisquam aut doloribus et.",
"description": "Repellat voluptas quibusdam voluptatem exercitationem.",
"state": "opened",
"created_at": "2016-04-05T21:41:45.652Z",
"updated_at": "2016-04-07T12:20:17.596Z",
2018-03-17 18:26:18 +05:30
"closed_at": null,
2018-05-09 12:01:36 +05:30
"closed_by": null,
2016-06-02 11:05:42 +05:30
"labels": [],
2019-03-02 22:35:43 +05:30
"upvotes": 4,
"downvotes": 0,
2019-07-07 11:18:12 +05:30
"merge_requests_count": 0,
2016-06-02 11:05:42 +05:30
"milestone": null,
2017-08-17 22:00:37 +05:30
"assignees": [{
"name": "Miss Monserrate Beier",
"username": "axel.block",
"id": 12,
"state": "active",
"avatar_url": "http://www.gravatar.com/avatar/46f6f7dc858ada7be1853f7fb96e81da?s=80&d=identicon",
"web_url": "https://gitlab.example.com/axel.block"
}],
2016-06-02 11:05:42 +05:30
"assignee": {
"name": "Miss Monserrate Beier",
"username": "axel.block",
"id": 12,
"state": "active",
"avatar_url": "http://www.gravatar.com/avatar/46f6f7dc858ada7be1853f7fb96e81da?s=80&d=identicon",
2016-11-03 12:29:30 +05:30
"web_url": "https://gitlab.example.com/axel.block"
2016-06-02 11:05:42 +05:30
},
"author": {
"name": "Kris Steuber",
"username": "solon.cremin",
"id": 10,
"state": "active",
"avatar_url": "http://www.gravatar.com/avatar/7a190fecbaa68212a4b68aeb6e3acd10?s=80&d=identicon",
2016-11-03 12:29:30 +05:30
"web_url": "https://gitlab.example.com/solon.cremin"
2016-08-24 12:49:21 +05:30
},
2016-09-29 09:46:39 +05:30
"due_date": null,
2020-03-13 15:44:24 +05:30
"web_url": "http://example.com/my-group/my-project/issues/11",
"references": {
"short": "#11",
"relative": "#11",
"full": "my-group/my-project#11"
},
2018-03-17 18:26:18 +05:30
"time_stats": {
"time_estimate": 0,
"total_time_spent": 0,
"human_time_estimate": null,
"human_total_time_spent": null
},
2017-09-10 17:25:29 +05:30
"confidential": false,
2018-03-17 18:26:18 +05:30
"discussion_locked": false,
2017-09-10 17:25:29 +05:30
"_links": {
"self": "http://example.com/api/v4/projects/1/issues/2",
"notes": "http://example.com/api/v4/projects/1/issues/2/notes",
"award_emoji": "http://example.com/api/v4/projects/1/issues/2/award_emoji",
"project": "http://example.com/api/v4/projects/1"
2019-09-04 21:01:54 +05:30
},
"task_completion_status":{
"count":0,
"completed_count":0
2017-09-10 17:25:29 +05:30
}
2016-06-02 11:05:42 +05:30
}
```
2019-09-30 21:07:59 +05:30
Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) will also see
the `weight` parameter:
```json
{
"project_id": 5,
"description": "Repellat voluptas quibusdam voluptatem exercitationem.",
"weight": null,
...
}
```
2017-08-17 22:00:37 +05:30
**Note**: `assignee` column is deprecated, now we show it as a single-sized array `assignees` to conform to the GitLab EE API.
2018-05-09 12:01:36 +05:30
**Note**: The `closed_by` attribute was [introduced in GitLab 10.6][ce-17042]. This value will only be present for issues which were closed after GitLab 10.6 and when the user account that closed the issue still exists.
2016-06-02 11:05:42 +05:30
## Unsubscribe from an issue
Unsubscribes the authenticated user from the issue to not receive notifications
2017-08-17 22:00:37 +05:30
from it. If the user is not subscribed to the issue, the
status code `304` is returned.
2016-06-02 11:05:42 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2017-08-17 22:00:37 +05:30
POST /projects/:id/issues/:issue_iid/unsubscribe
2016-06-02 11:05:42 +05:30
```
2017-08-17 22:00:37 +05:30
| Attribute | Type | Required | Description |
|-------------|---------|----------|--------------------------------------|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `issue_iid` | integer | yes | The internal ID of a project's issue |
2016-06-02 11:05:42 +05:30
2020-03-13 15:44:24 +05:30
```shell
2019-02-15 15:39:39 +05:30
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/issues/93/unsubscribe
2016-08-24 12:49:21 +05:30
```
2018-03-17 18:26:18 +05:30
Example response:
```json
{
"id": 93,
"iid": 12,
"project_id": 5,
"title": "Incidunt et rerum ea expedita iure quibusdam.",
"description": "Et cumque architecto sed aut ipsam.",
"state": "opened",
"created_at": "2016-04-05T21:41:45.217Z",
"updated_at": "2016-04-07T13:02:37.905Z",
"labels": [],
2019-03-02 22:35:43 +05:30
"upvotes": 4,
"downvotes": 0,
2019-07-07 11:18:12 +05:30
"merge_requests_count": 0,
2018-03-17 18:26:18 +05:30
"milestone": null,
"assignee": {
"name": "Edwardo Grady",
"username": "keyon",
"id": 21,
"state": "active",
"avatar_url": "http://www.gravatar.com/avatar/3e6f06a86cf27fa8b56f3f74f7615987?s=80&d=identicon",
"web_url": "https://gitlab.example.com/keyon"
},
2018-05-09 12:01:36 +05:30
"closed_at": null,
"closed_by": null,
2018-03-17 18:26:18 +05:30
"author": {
"name": "Vivian Hermann",
"username": "orville",
"id": 11,
"state": "active",
"avatar_url": "http://www.gravatar.com/avatar/5224fd70153710e92fb8bcf79ac29d67?s=80&d=identicon",
"web_url": "https://gitlab.example.com/orville"
},
"subscribed": false,
"due_date": null,
2020-03-13 15:44:24 +05:30
"web_url": "http://example.com/my-group/my-project/issues/12",
"references": {
"short": "#12",
"relative": "#12",
"full": "my-group/my-project#12"
},
2018-03-17 18:26:18 +05:30
"confidential": false,
2019-09-04 21:01:54 +05:30
"discussion_locked": false,
"task_completion_status":{
"count":0,
"completed_count":0
}
2018-03-17 18:26:18 +05:30
}
```
2016-08-24 12:49:21 +05:30
## Create a todo
2017-08-17 22:00:37 +05:30
Manually creates a todo for the current user on an issue. If
2016-08-24 12:49:21 +05:30
there already exists a todo for the user on that issue, status code `304` is
returned.
2020-04-08 14:13:33 +05:30
```plaintext
2017-08-17 22:00:37 +05:30
POST /projects/:id/issues/:issue_iid/todo
2016-08-24 12:49:21 +05:30
```
2017-08-17 22:00:37 +05:30
| Attribute | Type | Required | Description |
|-------------|---------|----------|--------------------------------------|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `issue_iid` | integer | yes | The internal ID of a project's issue |
2016-08-24 12:49:21 +05:30
2020-03-13 15:44:24 +05:30
```shell
2019-02-15 15:39:39 +05:30
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/issues/93/todo
2016-08-24 12:49:21 +05:30
```
Example response:
```json
{
"id": 112,
"project": {
"id": 5,
"name": "Gitlab Ci",
"name_with_namespace": "Gitlab Org / Gitlab Ci",
"path": "gitlab-ci",
"path_with_namespace": "gitlab-org/gitlab-ci"
},
"author": {
"name": "Administrator",
"username": "root",
"id": 1,
"state": "active",
"avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
2016-11-03 12:29:30 +05:30
"web_url": "https://gitlab.example.com/root"
2016-08-24 12:49:21 +05:30
},
"action_name": "marked",
"target_type": "Issue",
"target": {
"id": 93,
"iid": 10,
"project_id": 5,
"title": "Vel voluptas atque dicta mollitia adipisci qui at.",
"description": "Tempora laboriosam sint magni sed voluptas similique.",
"state": "closed",
"created_at": "2016-06-17T07:47:39.486Z",
"updated_at": "2016-07-01T11:09:13.998Z",
"labels": [],
"milestone": {
"id": 26,
"iid": 1,
"project_id": 5,
"title": "v0.0",
"description": "Accusantium nostrum rerum quae quia quis nesciunt suscipit id.",
"state": "closed",
"created_at": "2016-06-17T07:47:33.832Z",
"updated_at": "2016-06-17T07:47:33.832Z",
"due_date": null
},
2017-08-17 22:00:37 +05:30
"assignees": [{
"name": "Jarret O'Keefe",
"username": "francisca",
"id": 14,
"state": "active",
"avatar_url": "http://www.gravatar.com/avatar/a7fa515d53450023c83d62986d0658a8?s=80&d=identicon",
"web_url": "https://gitlab.example.com/francisca"
}],
2016-08-24 12:49:21 +05:30
"assignee": {
"name": "Jarret O'Keefe",
"username": "francisca",
"id": 14,
"state": "active",
"avatar_url": "http://www.gravatar.com/avatar/a7fa515d53450023c83d62986d0658a8?s=80&d=identicon",
2016-11-03 12:29:30 +05:30
"web_url": "https://gitlab.example.com/francisca"
2016-08-24 12:49:21 +05:30
},
"author": {
"name": "Maxie Medhurst",
"username": "craig_rutherford",
"id": 12,
"state": "active",
"avatar_url": "http://www.gravatar.com/avatar/a0d477b3ea21970ce6ffcbb817b0b435?s=80&d=identicon",
2016-11-03 12:29:30 +05:30
"web_url": "https://gitlab.example.com/craig_rutherford"
2016-08-24 12:49:21 +05:30
},
"subscribed": true,
"user_notes_count": 7,
"upvotes": 0,
2016-09-29 09:46:39 +05:30
"downvotes": 0,
2019-07-07 11:18:12 +05:30
"merge_requests_count": 0,
2016-09-29 09:46:39 +05:30
"due_date": null,
2020-03-13 15:44:24 +05:30
"web_url": "http://example.com/my-group/my-project/issues/10",
"references": {
"short": "#10",
"relative": "#10",
"full": "my-group/my-project#10"
},
2018-03-17 18:26:18 +05:30
"confidential": false,
2019-09-04 21:01:54 +05:30
"discussion_locked": false,
"task_completion_status":{
"count":0,
"completed_count":0
}
2016-06-02 11:05:42 +05:30
},
2016-08-24 12:49:21 +05:30
"target_url": "https://gitlab.example.com/gitlab-org/gitlab-ci/issues/10",
"body": "Vel voluptas atque dicta mollitia adipisci qui at.",
"state": "pending",
"created_at": "2016-07-01T11:09:13.992Z"
2016-06-02 11:05:42 +05:30
}
```
2017-08-17 22:00:37 +05:30
**Note**: `assignee` column is deprecated, now we show it as a single-sized array `assignees` to conform to the GitLab EE API.
2018-05-09 12:01:36 +05:30
**Note**: The `closed_by` attribute was [introduced in GitLab 10.6][ce-17042]. This value will only be present for issues which were closed after GitLab 10.6 and when the user account that closed the issue still exists.
2017-08-17 22:00:37 +05:30
## Set a time estimate for an issue
Sets an estimated time of work for this issue.
2020-04-08 14:13:33 +05:30
```plaintext
2017-08-17 22:00:37 +05:30
POST /projects/:id/issues/:issue_iid/time_estimate
```
| Attribute | Type | Required | Description |
|-------------|---------|----------|------------------------------------------|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `issue_iid` | integer | yes | The internal ID of a project's issue |
| `duration` | string | yes | The duration in human format. e.g: 3h30m |
2020-03-13 15:44:24 +05:30
```shell
2019-02-15 15:39:39 +05:30
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/issues/93/time_estimate?duration=3h30m
2017-08-17 22:00:37 +05:30
```
Example response:
```json
{
"human_time_estimate": "3h 30m",
"human_total_time_spent": null,
"time_estimate": 12600,
"total_time_spent": 0
}
```
## Reset the time estimate for an issue
Resets the estimated time for this issue to 0 seconds.
2020-04-08 14:13:33 +05:30
```plaintext
2017-08-17 22:00:37 +05:30
POST /projects/:id/issues/:issue_iid/reset_time_estimate
```
| Attribute | Type | Required | Description |
|-------------|---------|----------|--------------------------------------|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `issue_iid` | integer | yes | The internal ID of a project's issue |
2020-03-13 15:44:24 +05:30
```shell
2019-02-15 15:39:39 +05:30
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/issues/93/reset_time_estimate
2017-08-17 22:00:37 +05:30
```
Example response:
```json
{
"human_time_estimate": null,
"human_total_time_spent": null,
"time_estimate": 0,
"total_time_spent": 0
}
```
## Add spent time for an issue
Adds spent time for this issue
2020-04-08 14:13:33 +05:30
```plaintext
2017-08-17 22:00:37 +05:30
POST /projects/:id/issues/:issue_iid/add_spent_time
```
| Attribute | Type | Required | Description |
|-------------|---------|----------|------------------------------------------|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `issue_iid` | integer | yes | The internal ID of a project's issue |
| `duration` | string | yes | The duration in human format. e.g: 3h30m |
2020-03-13 15:44:24 +05:30
```shell
2019-02-15 15:39:39 +05:30
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/issues/93/add_spent_time?duration=1h
2017-08-17 22:00:37 +05:30
```
Example response:
```json
{
"human_time_estimate": null,
"human_total_time_spent": "1h",
"time_estimate": 0,
"total_time_spent": 3600
}
```
## Reset spent time for an issue
Resets the total spent time for this issue to 0 seconds.
2020-04-08 14:13:33 +05:30
```plaintext
2017-08-17 22:00:37 +05:30
POST /projects/:id/issues/:issue_iid/reset_spent_time
```
| Attribute | Type | Required | Description |
|-------------|---------|----------|--------------------------------------|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `issue_iid` | integer | yes | The internal ID of a project's issue |
2020-03-13 15:44:24 +05:30
```shell
2019-02-15 15:39:39 +05:30
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/issues/93/reset_spent_time
2017-08-17 22:00:37 +05:30
```
Example response:
```json
{
"human_time_estimate": null,
"human_total_time_spent": null,
"time_estimate": 0,
"total_time_spent": 0
}
```
## Get time tracking stats
2020-04-08 14:13:33 +05:30
```plaintext
2017-08-17 22:00:37 +05:30
GET /projects/:id/issues/:issue_iid/time_stats
```
| Attribute | Type | Required | Description |
|-------------|---------|----------|--------------------------------------|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `issue_iid` | integer | yes | The internal ID of a project's issue |
2020-03-13 15:44:24 +05:30
```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/issues/93/time_stats
2017-08-17 22:00:37 +05:30
```
Example response:
```json
{
"human_time_estimate": "2h",
"human_total_time_spent": "1h",
"time_estimate": 7200,
"total_time_spent": 3600
}
```
2018-12-13 13:39:08 +05:30
## List merge requests related to issue
Get all the merge requests that are related to the issue.
2020-04-08 14:13:33 +05:30
```plaintext
2018-12-13 13:39:08 +05:30
GET /projects/:id/issues/:issue_id/related_merge_requests
```
| Attribute | Type | Required | Description |
|-------------|---------|----------|--------------------------------------|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `issue_iid` | integer | yes | The internal ID of a project's issue |
2020-03-13 15:44:24 +05:30
```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/issues/11/related_merge_requests
2018-12-13 13:39:08 +05:30
```
Example response:
```json
[
{
"id": 29,
"iid": 11,
"project_id": 1,
"title": "Provident eius eos blanditiis consequatur neque odit.",
"description": "Ut consequatur ipsa aspernatur quisquam voluptatum fugit. Qui harum corporis quo fuga ut incidunt veritatis. Autem necessitatibus et harum occaecati nihil ea.\r\n\r\ntwitter/flight#8",
"state": "opened",
"created_at": "2018-09-18T14:36:15.510Z",
"updated_at": "2018-09-19T07:45:13.089Z",
2019-12-21 20:55:43 +05:30
"closed_by": null,
"closed_at": null,
2018-12-13 13:39:08 +05:30
"target_branch": "v2.x",
"source_branch": "so_long_jquery",
2019-12-21 20:55:43 +05:30
"user_notes_count": 9,
2018-12-13 13:39:08 +05:30
"upvotes": 0,
"downvotes": 0,
"author": {
"id": 14,
"name": "Verna Hills",
"username": "lawanda_reinger",
"state": "active",
"avatar_url": "https://www.gravatar.com/avatar/de68a91aeab1cff563795fb98a0c2cc0?s=80&d=identicon",
"web_url": "https://gitlab.example.com/lawanda_reinger"
},
"assignee": {
"id": 19,
"name": "Jody Baumbach",
"username": "felipa.kuvalis",
"state": "active",
"avatar_url": "https://www.gravatar.com/avatar/6541fc75fc4e87e203529bd275fafd07?s=80&d=identicon",
"web_url": "https://gitlab.example.com/felipa.kuvalis"
},
"source_project_id": 1,
"target_project_id": 1,
"labels": [],
"work_in_progress": false,
"milestone": {
"id": 27,
"iid": 2,
"project_id": 1,
"title": "v1.0",
"description": "Et tenetur voluptatem minima doloribus vero dignissimos vitae.",
"state": "active",
"created_at": "2018-09-18T14:35:44.353Z",
"updated_at": "2018-09-18T14:35:44.353Z",
"due_date": null,
"start_date": null,
"web_url": "https://gitlab.example.com/twitter/flight/milestones/2"
},
"merge_when_pipeline_succeeds": false,
"merge_status": "cannot_be_merged",
"sha": "3b7b528e9353295c1c125dad281ac5b5deae5f12",
"merge_commit_sha": null,
2019-12-26 22:10:19 +05:30
"squash_commit_sha": null,
2018-12-13 13:39:08 +05:30
"discussion_locked": null,
"should_remove_source_branch": null,
"force_remove_source_branch": false,
2019-12-21 20:55:43 +05:30
"reference": "!11",
2018-12-13 13:39:08 +05:30
"web_url": "https://gitlab.example.com/twitter/flight/merge_requests/4",
2020-03-13 15:44:24 +05:30
"references": {
"short": "!4",
"relative": "!4",
"full": "twitter/flight!4"
},
2018-12-13 13:39:08 +05:30
"time_stats": {
"time_estimate": 0,
"total_time_spent": 0,
"human_time_estimate": null,
"human_total_time_spent": null
},
2019-12-21 20:55:43 +05:30
"squash": false,
"task_completion_status": {
"count": 0,
"completed_count": 0
},
"changes_count": "10",
"latest_build_started_at": "2018-12-05T01:16:41.723Z",
"latest_build_finished_at": "2018-12-05T02:35:54.046Z",
"first_deployed_to_production_at": null,
"pipeline": {
"id": 38980952,
"sha": "81c6a84c7aebd45a1ac2c654aa87f11e32338e0a",
"ref": "test-branch",
"status": "success",
"web_url": "https://gitlab.com/gitlab-org/gitlab/pipelines/38980952"
},
"head_pipeline": {
"id": 38980952,
"sha": "81c6a84c7aebd45a1ac2c654aa87f11e32338e0a",
"ref": "test-branch",
"status": "success",
"web_url": "https://gitlab.example.com/twitter/flight/pipelines/38980952",
"before_sha": "3c738a37eb23cf4c0ed0d45d6ddde8aad4a8da51",
"tag": false,
"yaml_errors": null,
"user": {
"id": 19,
"name": "Jody Baumbach",
"username": "felipa.kuvalis",
"state": "active",
"avatar_url": "https://www.gravatar.com/avatar/6541fc75fc4e87e203529bd275fafd07?s=80&d=identicon",
"web_url": "https://gitlab.example.com/felipa.kuvalis"
},
"created_at": "2018-12-05T01:16:13.342Z",
"updated_at": "2018-12-05T02:35:54.086Z",
"started_at": "2018-12-05T01:16:41.723Z",
"finished_at": "2018-12-05T02:35:54.046Z",
"committed_at": null,
"duration": 4436,
"coverage": "46.68",
"detailed_status": {
"icon": "status_warning",
"text": "passed",
"label": "passed with warnings",
"group": "success-with-warnings",
"tooltip": "passed",
"has_details": true,
"details_path": "/twitter/flight/pipelines/38",
"illustration": null,
"favicon": "https://gitlab.example.com/assets/ci_favicons/favicon_status_success-8451333011eee8ce9f2ab25dc487fe24a8758c694827a582f17f42b0a90446a2.png"
}
},
"diff_refs": {
"base_sha": "d052d768f0126e8cddf80afd8b1eb07f406a3fcb",
"head_sha": "81c6a84c7aebd45a1ac2c654aa87f11e32338e0a",
"start_sha": "d052d768f0126e8cddf80afd8b1eb07f406a3fcb"
},
"merge_error": null,
"user": {
"can_merge": true
}
2018-12-13 13:39:08 +05:30
}
]
```
2017-08-17 22:00:37 +05:30
## List merge requests that will close issue on merge
Get all the merge requests that will close issue when merged.
2020-04-08 14:13:33 +05:30
```plaintext
2017-08-17 22:00:37 +05:30
GET /projects/:id/issues/:issue_iid/closed_by
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer | yes | The ID of a project |
| `issue_iid` | integer | yes | The internal ID of a project issue |
2020-03-13 15:44:24 +05:30
```shell
2019-02-15 15:39:39 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/issues/11/closed_by
2017-08-17 22:00:37 +05:30
```
Example response:
```json
[
{
"id": 6471,
"iid": 6432,
"project_id": 1,
"title": "add a test for cgi lexer options",
"description": "closes #11",
"state": "opened",
"created_at": "2017-04-06T18:33:34.168Z",
"updated_at": "2017-04-09T20:10:24.983Z",
"target_branch": "master",
"source_branch": "feature.custom-highlighting",
"upvotes": 0,
"downvotes": 0,
"author": {
"name": "Administrator",
"username": "root",
"id": 1,
"state": "active",
"avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
"web_url": "https://gitlab.example.com/root"
},
"assignee": null,
"source_project_id": 1,
"target_project_id": 1,
2018-05-09 12:01:36 +05:30
"closed_at": null,
"closed_by": null,
2017-08-17 22:00:37 +05:30
"labels": [],
"work_in_progress": false,
"milestone": null,
"merge_when_pipeline_succeeds": false,
"merge_status": "unchecked",
"sha": "5a62481d563af92b8e32d735f2fa63b94e806835",
"merge_commit_sha": null,
2019-12-26 22:10:19 +05:30
"squash_commit_sha": null,
2017-08-17 22:00:37 +05:30
"user_notes_count": 1,
"should_remove_source_branch": null,
"force_remove_source_branch": false,
2018-03-17 18:26:18 +05:30
"web_url": "https://gitlab.example.com/gitlab-org/gitlab-test/merge_requests/6432",
2020-03-13 15:44:24 +05:30
"reference": "!6432",
"references": {
"short": "!6432",
"relative": "!6432",
"full": "gitlab-org/gitlab-test!6432"
},
2018-03-17 18:26:18 +05:30
"time_stats": {
"time_estimate": 0,
"total_time_spent": 0,
"human_time_estimate": null,
"human_total_time_spent": null
}
}
]
```
## Participants on issues
2020-04-08 14:13:33 +05:30
```plaintext
2018-03-17 18:26:18 +05:30
GET /projects/:id/issues/:issue_iid/participants
```
| Attribute | Type | Required | Description |
|-------------|---------|----------|--------------------------------------|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `issue_iid` | integer | yes | The internal ID of a project's issue |
2020-03-13 15:44:24 +05:30
```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/issues/93/participants
2018-03-17 18:26:18 +05:30
```
Example response:
```json
[
{
"id": 1,
"name": "John Doe1",
"username": "user1",
"state": "active",
"avatar_url": "http://www.gravatar.com/avatar/c922747a93b40d1ea88262bf1aebee62?s=80&d=identicon",
"web_url": "http://localhost/user1"
},
{
"id": 5,
"name": "John Doe5",
"username": "user5",
"state": "active",
"avatar_url": "http://www.gravatar.com/avatar/4aea8cf834ed91844a2da4ff7ae6b491?s=80&d=identicon",
"web_url": "http://localhost/user5"
2017-08-17 22:00:37 +05:30
}
]
```
2014-09-02 18:07:02 +05:30
## Comments on issues
2016-04-02 18:10:28 +05:30
Comments are done via the [notes](notes.md) resource.
2017-09-10 17:25:29 +05:30
## Get user agent details
Available only for admins.
2020-04-08 14:13:33 +05:30
```plaintext
2017-09-10 17:25:29 +05:30
GET /projects/:id/issues/:issue_iid/user_agent_detail
```
| Attribute | Type | Required | Description |
|-------------|---------|----------|--------------------------------------|
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `issue_iid` | integer | yes | The internal ID of a project's issue |
2020-03-13 15:44:24 +05:30
```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/issues/93/user_agent_detail
2017-09-10 17:25:29 +05:30
```
Example response:
```json
{
"user_agent": "AppleWebKit/537.36",
"ip_address": "127.0.0.1",
"akismet_submitted": false
}
```
2020-03-13 15:44:24 +05:30
[ce-13004]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/13004
[ce-14016]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/14016
[ce-17042]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/17042
[ce-18935]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/18935