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

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

182 lines
6.5 KiB
Markdown
Raw Normal View History

2020-06-23 00:09:42 +05:30
---
stage: Plan
group: Project Management
2021-02-22 17:27:13 +05:30
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
2020-06-23 00:09:42 +05:30
---
2021-09-30 23:02:18 +05:30
# Group milestones API **(FREE)**
2017-09-10 17:25:29 +05:30
2021-09-30 23:02:18 +05:30
Use the group [milestones](../user/project/milestones/index.md) using the REST API.
2021-01-29 00:20:46 +05:30
There's a separate [project milestones API](milestones.md) page.
2020-06-23 00:09:42 +05:30
2017-09-10 17:25:29 +05:30
## List group milestones
Returns a list of group milestones.
2020-04-08 14:13:33 +05:30
```plaintext
2017-09-10 17:25:29 +05:30
GET /groups/:id/milestones
GET /groups/:id/milestones?iids[]=42
GET /groups/:id/milestones?iids[]=42&iids[]=43
GET /groups/:id/milestones?state=active
GET /groups/:id/milestones?state=closed
2019-07-07 11:18:12 +05:30
GET /groups/:id/milestones?title=1.0
2017-09-10 17:25:29 +05:30
GET /groups/:id/milestones?search=version
```
Parameters:
2020-10-24 23:57:45 +05:30
| Attribute | Type | Required | Description |
| --------- | ------ | -------- | ----------- |
2021-09-30 23:02:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the group](index.md#namespaced-path-encoding) owned by the authenticated user |
2020-10-24 23:57:45 +05:30
| `iids[]` | integer array | no | Return only the milestones having the given `iid` (Note: ignored if `include_parent_milestones` is set as `true`) |
| `state` | string | no | Return only `active` or `closed` milestones |
| `title` | string | no | Return only the milestones having the given `title` |
| `search` | string | no | Return only milestones with a title or description matching the provided string |
2021-11-11 11:23:49 +05:30
| `include_parent_milestones` | boolean | optional | Include milestones from parent group and its ancestors. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/196066) in GitLab 13.4 |
2017-09-10 17:25:29 +05:30
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/milestones"
2017-09-10 17:25:29 +05:30
```
Example Response:
```json
[
{
"id": 12,
"iid": 3,
"group_id": 16,
"title": "10.0",
"description": "Version",
"due_date": "2013-11-29",
"start_date": "2013-11-10",
"state": "active",
"updated_at": "2013-10-02T09:24:18Z",
2020-05-24 23:13:21 +05:30
"created_at": "2013-10-02T09:24:18Z",
2020-11-24 15:15:51 +05:30
"expired": false,
2020-05-24 23:13:21 +05:30
"web_url": "https://gitlab.com/groups/gitlab-org/-/milestones/42"
2017-09-10 17:25:29 +05:30
}
]
```
## Get single milestone
Gets a single group milestone.
2020-04-08 14:13:33 +05:30
```plaintext
2017-09-10 17:25:29 +05:30
GET /groups/:id/milestones/:milestone_id
```
Parameters:
2020-05-24 23:13:21 +05:30
| Attribute | Type | Required | Description |
| --------- | ------ | -------- | ----------- |
2021-09-30 23:02:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the group](index.md#namespaced-path-encoding) owned by the authenticated user |
2020-05-24 23:13:21 +05:30
| `milestone_id` | integer | yes | The ID of the group milestone |
2017-09-10 17:25:29 +05:30
## Create new milestone
Creates a new group milestone.
2020-04-08 14:13:33 +05:30
```plaintext
2017-09-10 17:25:29 +05:30
POST /groups/:id/milestones
```
Parameters:
2020-05-24 23:13:21 +05:30
| Attribute | Type | Required | Description |
| --------- | ------ | -------- | ----------- |
2021-09-30 23:02:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the group](index.md#namespaced-path-encoding) owned by the authenticated user |
2020-05-24 23:13:21 +05:30
| `title` | string | yes | The title of a milestone |
| `description` | string | no | The description of the milestone |
2021-10-27 15:23:28 +05:30
| `due_date` | date | no | The due date of the milestone, in ISO 8601 format (`YYYY-MM-DD`) |
| `start_date` | date | no | The start date of the milestone, in ISO 8601 format (`YYYY-MM-DD`) |
2017-09-10 17:25:29 +05:30
## Edit milestone
Updates an existing group milestone.
2020-04-08 14:13:33 +05:30
```plaintext
2017-09-10 17:25:29 +05:30
PUT /groups/:id/milestones/:milestone_id
```
Parameters:
2020-05-24 23:13:21 +05:30
| Attribute | Type | Required | Description |
| --------- | ------ | -------- | ----------- |
2021-09-30 23:02:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the group](index.md#namespaced-path-encoding) owned by the authenticated user |
2020-05-24 23:13:21 +05:30
| `milestone_id` | integer | yes | The ID of a group milestone |
| `title` | string | no | The title of a milestone |
| `description` | string | no | The description of a milestone |
2021-10-27 15:23:28 +05:30
| `due_date` | date | no | The due date of the milestone, in ISO 8601 format (`YYYY-MM-DD`) |
| `start_date` | date | no | The start date of the milestone, in ISO 8601 format (`YYYY-MM-DD`) |
2020-05-24 23:13:21 +05:30
| `state_event` | string | no | The state event of the milestone _(`close` or `activate`)_ |
2017-09-10 17:25:29 +05:30
2018-11-20 20:47:30 +05:30
## Delete group milestone
2021-09-30 23:02:18 +05:30
Only for users with the Developer role in the group.
2018-11-20 20:47:30 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2018-11-20 20:47:30 +05:30
DELETE /groups/:id/milestones/:milestone_id
```
Parameters:
2020-05-24 23:13:21 +05:30
| Attribute | Type | Required | Description |
| --------- | ------ | -------- | ----------- |
2021-09-30 23:02:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the group](index.md#namespaced-path-encoding) owned by the authenticated user |
2020-05-24 23:13:21 +05:30
| `milestone_id` | integer | yes | The ID of the group's milestone |
2018-11-20 20:47:30 +05:30
2017-09-10 17:25:29 +05:30
## Get all issues assigned to a single milestone
Gets all issues assigned to a single group milestone.
2020-04-08 14:13:33 +05:30
```plaintext
2017-09-10 17:25:29 +05:30
GET /groups/:id/milestones/:milestone_id/issues
```
Parameters:
2020-05-24 23:13:21 +05:30
| Attribute | Type | Required | Description |
| --------- | ------ | -------- | ----------- |
2021-09-30 23:02:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the group](index.md#namespaced-path-encoding) owned by the authenticated user |
2020-05-24 23:13:21 +05:30
| `milestone_id` | integer | yes | The ID of a group milestone |
2017-09-10 17:25:29 +05:30
2021-09-04 01:27:46 +05:30
Currently, this API endpoint doesn't return issues from any subgroups.
If you want to get all the milestones' issues, you can instead use the
[List issues API](issues.md#list-issues) and filter for a
particular milestone (for example, `GET /issues?milestone=1.0.0&state=opened`).
2017-09-10 17:25:29 +05:30
## Get all merge requests assigned to a single milestone
Gets all merge requests assigned to a single group milestone.
2020-04-08 14:13:33 +05:30
```plaintext
2017-09-10 17:25:29 +05:30
GET /groups/:id/milestones/:milestone_id/merge_requests
```
Parameters:
2020-05-24 23:13:21 +05:30
| Attribute | Type | Required | Description |
| --------- | ------ | -------- | ----------- |
2021-09-30 23:02:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the group](index.md#namespaced-path-encoding) owned by the authenticated user |
2020-05-24 23:13:21 +05:30
| `milestone_id` | integer | yes | The ID of a group milestone |
2019-09-30 21:07:59 +05:30
2021-03-11 19:13:27 +05:30
## Get all burndown chart events for a single milestone **(PREMIUM)**
2019-09-30 21:07:59 +05:30
2021-03-11 19:13:27 +05:30
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/4737) in GitLab 12.1
> - Moved to GitLab Premium in 13.9.
2019-09-30 21:07:59 +05:30
Get all burndown chart events for a single milestone.
2020-04-08 14:13:33 +05:30
```plaintext
2019-09-30 21:07:59 +05:30
GET /groups/:id/milestones/:milestone_id/burndown_events
```
Parameters:
2020-05-24 23:13:21 +05:30
| Attribute | Type | Required | Description |
| --------- | ------ | -------- | ----------- |
2021-09-30 23:02:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the group](index.md#namespaced-path-encoding) owned by the authenticated user |
2020-05-24 23:13:21 +05:30
| `milestone_id` | integer | yes | The ID of a group milestone |