# Group milestones API

> 原文：[https://docs.gitlab.com/ee/api/group_milestones.html](https://docs.gitlab.com/ee/api/group_milestones.html)

*   [List group milestones](#list-group-milestones)
*   [Get single milestone](#get-single-milestone)
*   [Create new milestone](#create-new-milestone)
*   [Edit milestone](#edit-milestone)
*   [Delete group milestone](#delete-group-milestone)
*   [Get all issues assigned to a single milestone](#get-all-issues-assigned-to-a-single-milestone)
*   [Get all merge requests assigned to a single milestone](#get-all-merge-requests-assigned-to-a-single-milestone)
*   [Get all burndown chart events for a single milestone](#get-all-burndown-chart-events-for-a-single-milestone-starter)

# Group milestones API[](#group-milestones-api "Permalink")

在 GitLab 9.5 中[引入](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/12819) .

此页面描述了组里程碑 API. 有一个单独的[项目里程碑 API](./group_milestones.html)页面.

## List group milestones[](#list-group-milestones "Permalink")

返回组里程碑列表.

```
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
GET /groups/:id/milestones?title=1.0
GET /groups/:id/milestones?search=version 
```

Parameters:

| Attribute | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | integer/string | yes | 认证用户拥有[的组](README.html#namespaced-path-encoding)的 ID 或[URL 编码路径](README.html#namespaced-path-encoding) |
| `iids[]` | 整数数组 | no | 仅返回具有给定`iid`的里程碑 |
| `state` | string | no | 仅返回`active`或`closed`里程碑 |
| `title` | string | no | 仅返回具有给定`title`的里程碑 |
| `search` | string | no | 仅返回标题或描述与提供的字符串匹配的里程碑 |

```
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/milestones" 
```

示例响应：

```
[  {  "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",  "created_at":  "2013-10-02T09:24:18Z",  "web_url":  "https://gitlab.com/groups/gitlab-org/-/milestones/42"  }  ] 
```

## Get single milestone[](#get-single-milestone "Permalink")

获取单个组里程碑.

```
GET /groups/:id/milestones/:milestone_id 
```

Parameters:

| Attribute | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | integer/string | yes | 认证用户拥有[的组](README.html#namespaced-path-encoding)的 ID 或[URL 编码路径](README.html#namespaced-path-encoding) |
| `milestone_id` | integer | yes | 组里程碑的 ID |

## Create new milestone[](#create-new-milestone "Permalink")

创建一个新的组里程碑.

```
POST /groups/:id/milestones 
```

Parameters:

| Attribute | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | integer/string | yes | 认证用户拥有[的组](README.html#namespaced-path-encoding)的 ID 或[URL 编码路径](README.html#namespaced-path-encoding) |
| `title` | string | yes | 里程碑的标题 |
| `description` | string | no | 里程碑的描述 |
| `due_date` | date | no | 里程碑的到期日期，格式为 YYYY-MM-DD（ISO 8601） |
| `start_date` | date | no | 里程碑的开始日期，格式为 YYYY-MM-DD（ISO 8601） |

## Edit milestone[](#edit-milestone "Permalink")

更新现有的组里程碑.

```
PUT /groups/:id/milestones/:milestone_id 
```

Parameters:

| Attribute | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | integer/string | yes | 认证用户拥有[的组](README.html#namespaced-path-encoding)的 ID 或[URL 编码路径](README.html#namespaced-path-encoding) |
| `milestone_id` | integer | yes | 组里程碑的 ID |
| `title` | string | no | 里程碑的标题 |
| `description` | string | no | 里程碑的描述 |
| `due_date` | date | no | 里程碑的到期日期，格式为 YYYY-MM-DD（ISO 8601） |
| `start_date` | date | no | 里程碑的开始日期，格式为 YYYY-MM-DD（ISO 8601） |
| `state_event` | string | no | 里程碑的状态事件*（ `close`或`activate` ）* |

## Delete group milestone[](#delete-group-milestone "Permalink")

仅针对具有开发者访问权限的用户.

```
DELETE /groups/:id/milestones/:milestone_id 
```

Parameters:

| Attribute | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | integer/string | yes | 认证用户拥有[的组](README.html#namespaced-path-encoding)的 ID 或[URL 编码路径](README.html#namespaced-path-encoding) |
| `milestone_id` | integer | yes | 小组里程碑的 ID |

## Get all issues assigned to a single milestone[](#get-all-issues-assigned-to-a-single-milestone "Permalink")

获取分配给单个组里程碑的所有问题.

```
GET /groups/:id/milestones/:milestone_id/issues 
```

Parameters:

| Attribute | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | integer/string | yes | 认证用户拥有[的组](README.html#namespaced-path-encoding)的 ID 或[URL 编码路径](README.html#namespaced-path-encoding) |
| `milestone_id` | integer | yes | 组里程碑的 ID |

## Get all merge requests assigned to a single milestone[](#get-all-merge-requests-assigned-to-a-single-milestone "Permalink")

获取分配给单个组里程碑的所有合并请求.

```
GET /groups/:id/milestones/:milestone_id/merge_requests 
```

Parameters:

| Attribute | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | integer/string | yes | 认证用户拥有[的组](README.html#namespaced-path-encoding)的 ID 或[URL 编码路径](README.html#namespaced-path-encoding) |
| `milestone_id` | integer | yes | 组里程碑的 ID |

## Get all burndown chart events for a single milestone[](#get-all-burndown-chart-events-for-a-single-milestone-starter "Permalink")

在 GitLab 12.1 中[引入](https://gitlab.com/gitlab-org/gitlab/-/issues/4737)

获取单个里程碑的所有燃尽图事件.

```
GET /groups/:id/milestones/:milestone_id/burndown_events 
```

Parameters:

| Attribute | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | integer/string | yes | 认证用户拥有[的组](README.html#namespaced-path-encoding)的 ID 或[URL 编码路径](README.html#namespaced-path-encoding) |
| `milestone_id` | integer | yes | 组里程碑的 ID |