群组里程碑 API

通过 REST API 使用群组里程碑。您也可以阅读项目里程碑 API 页面。

列出群组里程碑

返回群组里程碑列表。

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
GET /groups/:id/milestones?search_title=17.3+17.4
GET /groups/:id/milestones?search_title=17.3%2017.4
GET /groups/:id/milestones?updated_before=2013-10-02T09%3A24%3A18Z
GET /groups/:id/milestones?updated_after=2013-10-02T09%3A24%3A18Z
GET /groups/:id/milestones?containing_date=2013-10-02T09%3A24%3A18Z
GET /groups/:id/milestones?start_date=2013-10-02T09%3A24%3A18Z&end_date=2013-11-02T09%3A24%3A18Z

参数：

参数 类型 是否必需 描述
id integer/string yes 经过身份验证的用户拥有的 ID 或 URL 编码的群组路径
iids[] integer array no 仅返回带有给定 iid 的里程碑（注意：如果 include_parent_milestones 设置为 true，则忽略)
state string no 仅返回 active 或 closed 里程碑
title string no 仅返回带有给定 title 的里程碑
search string no 仅返回标题或描述匹配提供的资源串的里程碑
search_title string no 仅返回与提供主题相匹配的里程碑（大消息敏感）。可以提供多个术语，用空格隔开，或者使用 + 或 %20， 也可以进行叠加。比如：17.4+17.5 将会匹配子字符串 17.4 和 17.5 (顺序随意)。引入于 11.8。
include_parent_milestones boolean no 包括父群组及其祖先群组的里程碑，引入于极狐GitLab 13.4
include_ancestors boolean no 包括所有父群组的里程碑。
include_descendants boolean no 包括群组及其子群组的里程碑。引入于 16.7。
updated_before datetime no 仅返回给定日期时间之前更新的里程碑。预计格式为 ISO 8601（2019-03-15T08:00:00Z）。引入于 15.10
updated_after datetime no 仅返回给定日期时间之后更新的里程碑。预计格式为 ISO 8601（2019-03-15T08:00:00Z）。引入于 15.10
containing_date datetime no 仅返回符合 start_date <= containing_date <= due_date 条件的里程碑。期望格式为 ISO 8601 (2019-03-15T08:00:00Z)。 引入于 13.5。
start_date datetime no 仅返回在 due_date >= 中提供 start_date 值的里程碑。期望格式为 ISO 8601 (2019-03-15T08:00:00Z)。注意：仅当同时提供 end_date 时有效。引入于 12.8。
end_date datetime no 仅返回在 start_date 中提供 end_date 值的里程碑。 期望格式为 ISO 8601 (2019-03-15T08:00:00Z)。 注意：仅当同时提供 start_date 时有效。引入于 12.8。 
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",
    "expired": false,
    "web_url": "https://gitlab.com/groups/gitlab-org/-/milestones/42"
  }
]

获取单个里程碑

获取单个群组里程碑。

GET /groups/:id/milestones/:milestone_id

参数：

参数 类型 是否必需 描述
id integer/string yes 经过身份验证的用户拥有的 ID 或 URL 编码的群组路径
milestone_id integer yes 群组里程碑 ID

创建新的里程碑

创建新的群组里程碑。

POST /groups/:id/milestones

参数：

参数 类型 是否必需 描述
id integer/string yes 经过身份验证的用户拥有的 ID 或 URL 编码的群组路径
title string yes 里程碑的标题
description string no 里程碑的描述
due_date date no 里程碑的截止日期，格式为 ISO 8601（YYYY-MM-DD）
start_date date no 里程碑的开始日期，格式为 ISO 8601（YYYY-MM-DD）

编辑里程碑

更新现存的群组里程碑。

PUT /groups/:id/milestones/:milestone_id

参数：

参数 类型 是否必需 描述
id integer/string yes 经过身份验证的用户拥有的 ID 或 URL 编码的群组路径
milestone_id integer yes 群组里程碑 ID
title string no 里程碑的标题
description string no 里程碑的描述
due_date date no 里程碑的截止日期，格式为 ISO 8601（YYYY-MM-DD）
start_date date no 里程碑的开始日期，格式为 ISO 8601（YYYY-MM-DD）
state_event string no 里程碑的状态事件 （close 或 activate）

删除群组里程碑

只有群组的开发者角色才能进行这个操作。

DELETE /groups/:id/milestones/:milestone_id

参数

参数 类型 是否必需 描述
id integer/string yes 经过身份验证的用户拥有的 ID 或 URL 编码的群组路径
milestone_id integer yes 群组里程碑 ID

获取分配给单个里程碑的所有议题

获取分配给单个群组里程碑的所有议题。

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

参数：

参数 类型 是否必需 描述
id integer/string yes 经过身份验证的用户拥有的 ID 或 URL 编码的群组路径
milestone_id integer yes 群组里程碑 ID

目前，此 API 端点不返回子群组的议题。 如果您想获得所有里程碑的议题，您可以使用列出议题 API 并筛选特定的里程碑（例如，GET /issues?milestone=1.0.0&state=opened）。

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

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

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

参数：

参数 类型 是否必需 描述
id integer/string yes 经过身份验证的用户拥有的 ID 或 URL 编码的群组路径
milestone_id integer yes 群组里程碑 ID

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

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

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

参数：

参数 类型 是否必需 描述
id integer/string yes 经过身份验证的用户拥有的 ID 或 URL 编码的群组路径
milestone_id integer yes 群组里程碑 ID