Group milestones API · Gitlab 中文文檔

# 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 |