{{< details >}}

  • Tier: 基础版, 专业版, 旗舰版
  • Offering: JihuLab.com, 私有化部署

{{< /details >}}

使用项目里程碑与 REST API。这里有一个单独的群组里程碑 API页面。

列出项目里程碑

返回项目里程碑列表。

GET /projects/:id/milestones
GET /projects/:id/milestones?iids[]=42
GET /projects/:id/milestones?iids[]=42&iids[]=43
GET /projects/:id/milestones?state=active
GET /projects/:id/milestones?state=closed
GET /projects/:id/milestones?title=1.0
GET /projects/:id/milestones?search=version
GET /projects/:id/milestones?updated_before=2013-10-02T09%3A24%3A18Z
GET /projects/:id/milestones?updated_after=2013-10-02T09%3A24%3A18Z

参数：

属性 类型 是否必需 描述
id 整数或字符串 是 项目的 ID 或URL 编码路径
iids[] 整数数组 否 仅返回具有给定 iid 的里程碑。如果 include_ancestors 为 true，则忽略。
state 字符串 否 仅返回 active 或 closed 的里程碑
title 字符串 否 仅返回具有给定 title 的里程碑
search 字符串 否 仅返回标题或描述与提供的字符串匹配的里程碑
include_parent_milestones 布尔值 否 弃用于极狐GitLab 16.7。请改用 include_ancestors。
include_ancestors 布尔值 否 包括所有父群组的里程碑。
updated_before 日期时间 否 仅返回在给定日期时间之前更新的里程碑。预期格式为 ISO 8601 (2019-03-15T08:00:00Z)。引入于极狐GitLab 15.10
updated_after 日期时间 否 仅返回在给定日期时间之后更新的里程碑。预期格式为 ISO 8601 (2019-03-15T08:00:00Z)。引入于极狐GitLab 15.10 
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/milestones"

示例响应：

[
  {
    "id": 12,
    "iid": 3,
    "project_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
  }
]

获取单个里程碑

获取单个项目里程碑。

GET /projects/:id/milestones/:milestone_id

参数：

属性 类型 是否必需 描述
id 整数或字符串 是 项目的 ID 或URL 编码路径
milestone_id 整数 是 项目的里程碑 ID

创建新里程碑

创建一个新的项目里程碑。

POST /projects/:id/milestones

参数：

属性 类型 是否必需 描述
id 整数或字符串 是 项目的 ID 或URL 编码路径
title 字符串 是 里程碑的标题
description 字符串 否 里程碑的描述
due_date 字符串 否 里程碑的截止日期 (YYYY-MM-DD)
start_date 字符串 否 里程碑的开始日期 (YYYY-MM-DD)

编辑里程碑

更新现有的项目里程碑。

PUT /projects/:id/milestones/:milestone_id

参数：

属性 类型 是否必需 描述
id 整数或字符串 是 项目的 ID 或URL 编码路径
milestone_id 整数 是 项目的里程碑 ID
title 字符串 否 里程碑的标题
description 字符串 否 里程碑的描述
due_date 字符串 否 里程碑的截止日期 (YYYY-MM-DD)
start_date 字符串 否 里程碑的开始日期 (YYYY-MM-DD)
state_event 字符串 否 里程碑的状态事件（关闭或激活）

删除项目里程碑

{{< history >}}

  • 在极狐GitLab 15.0 中，最低用户角色从开发者更改为报告者。
  • 在极狐GitLab 17.7 中，最低用户角色从报告者更改为计划者。

{{< /history >}}

仅适用于至少具有项目 Planner 角色的用户。

DELETE /projects/:id/milestones/:milestone_id

参数：

属性 类型 是否必需 描述
id 整数或字符串 是 项目的 ID 或URL 编码路径
milestone_id 整数 是 项目的里程碑 ID

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

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

GET /projects/:id/milestones/:milestone_id/issues

参数：

属性 类型 是否必需 描述
id 整数或字符串 是 项目的 ID 或URL 编码路径
milestone_id 整数 是 项目的里程碑 ID

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

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

GET /projects/:id/milestones/:milestone_id/merge_requests

参数：

属性 类型 是否必需 描述
id 整数或字符串 是 项目的 ID 或URL 编码路径
milestone_id 整数 是 项目的里程碑 ID

将项目里程碑提升为群组里程碑

{{< history >}}

  • 在极狐GitLab 15.0 中，最低用户角色从开发者更改为报告者。
  • 在极狐GitLab 17.7 中，最低用户角色从报告者更改为计划者。

{{< /history >}}

仅适用于至少具有群组 Planner 角色的用户。

POST /projects/:id/milestones/:milestone_id/promote

参数：

属性 类型 是否必需 描述
id 整数或字符串 是 项目的 ID 或URL 编码路径
milestone_id 整数 是 项目的里程碑 ID

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

{{< details >}}

  • Tier: 专业版, 旗舰版
  • Offering: JihuLab.com, 私有化部署

{{< /details >}}

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

GET /projects/:id/milestones/:milestone_id/burndown_events

参数：

属性 类型 是否必需 描述
id 整数或字符串 是 项目的 ID 或URL 编码路径
milestone_id 整数 是 项目的里程碑 ID