グループのマイルストーン API

GitLab 9.5で導入されました。

このページでは、グループマイルストーン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

パラメーター

属性 タイプ 必須 説明
id 整数/文字列 はい 認証されたユーザーが所有するグループのIDまたはURLエンコードされたパス。
iids[] 整数配列 いいえ を持つマイルストーンのみを返します。iid
state 列 いいえ active またはclosed マイルストーンのみ返却
title 列 いいえ を持つマイルストーンのみを返します。title
search 列 いいえ 指定した文字列にマッチするタイトルあるいは説明を持つマイルストーンのみを返します。 
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"
  }
]

マイルストーン取得

グループのマイルストーンを1つ取得します。 

GET /groups/:id/milestones/:milestone_id

パラメーター

属性 タイプ 必須 説明
id 整数/文字列 はい 認証されたユーザーが所有するグループのIDまたはURLエンコードされたパス。
milestone_id 整数 はい マイルストーンのグループID。

新しいマイルストーンの作成

新しいグループのマイルストーンを作成します。 

POST /groups/:id/milestones

パラメーター

属性 タイプ 必須 説明
id 整数/文字列 はい 認証されたユーザーが所有するグループのIDまたはURLエンコードされたパス。
title 列 はい マイルストーンのタイトル
description 列 いいえ マイルストーンの説明
due_date 日付 いいえ マイルストーンの期日 (YYYY-MM-DD形式 (ISO 8601))。
start_date 日付 いいえ マイルストーンの開始日 (YYYY-MM-DD形式 (ISO 8601))。

編集マイルストーン

既存のグループのマイルストーンを更新します。 

PUT /groups/:id/milestones/:milestone_id

パラメーター

属性 タイプ 必須 説明
id 整数/文字列 はい 認証されたユーザーが所有するグループのIDまたはURLエンコードされたパス。
milestone_id 整数 はい グループのマイルストーンのID。
title 列 いいえ マイルストーンのタイトル
description 列 いいえ マイルストーンの説明
due_date 日付 いいえ マイルストーンの期日 (YYYY-MM-DD形式 (ISO 8601))。
start_date 日付 いいえ マイルストーンの開始日 (YYYY-MM-DD形式 (ISO 8601))。
state_event 列 いいえ マイルストーンの状態イベント_(close またはactivate)_

グループマイルストーンの削除

グループに開発者アクセス権を持つユーザーのみ。 

DELETE /groups/:id/milestones/:milestone_id

パラメーター

属性 タイプ 必須 説明
id 整数/文字列 はい 認証されたユーザーが所有するグループのIDまたはURLエンコードされたパス。
milestone_id 整数 はい グループのマイルストーンのID

マイルストーンに割り当てられたすべてのイシューを取得します。

単一のグループマイルストーンに割り当てられているすべてのイシューを取得します。 

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

パラメーター

属性 タイプ 必須 説明
id 整数/文字列 はい 認証されたユーザーが所有するグループのIDまたはURLエンコードされたパス。
milestone_id 整数 はい グループのマイルストーンのID。

単一のマイルストーンに割り当てられたすべてのマージリクエストを取得します。

単一のグループマイルストーンに割り当てられているすべてのマージリクエストを取得します。 

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

パラメーター

属性 タイプ 必須 説明
id 整数/文字列 はい 認証されたユーザーが所有するグループのIDまたはURLエンコードされたパス。
milestone_id 整数 はい グループのマイルストーンのID。

単一のマイルストーンに関するすべてのバーンダウンチャートイベントを取得します。

GitLab 12.1 で導入されました。

単一のマイルストーンのすべてのバーンダウンチャートイベントを取得します。 

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

パラメーター

属性 タイプ 必須 説明
id 整数/文字列 はい 認証されたユーザーが所有するグループのIDまたはURLエンコードされたパス。
milestone_id 整数 はい グループのマイルストーンのID。