グループのマイルストーン 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?updated_before=2013-10-02T09%3A24%3A18Z
GET /groups/:id/milestones?updated_after=2013-10-02T09%3A24%3A18Z

パラメータを指定します:

属性種類必須説明
id整数/文字列yes認証ユーザーが所有するグループのIDまたはURLエンコードされたパス
iids[]整数配列。いいえ指定されたiid を持つマイルストーンのみを返します (注意:include_parent_milestonestrueに設定されている場合は無視されます)。
state文字列です。いいえ active またはclosed マイルストーンのみを返します。
title文字列です。いいえ指定されたマイルストーンのみを返します。title
search文字列です。いいえ指定した文字列と一致するタイトルまたは説明を持つマイルストーンのみを返します。
include_parent_milestonesbooleanいいえ親グループとその先祖のマイルストーンを含めます。GitLab 13.4 で導入
updated_beforedatetimeいいえ指定された日時より前に更新されたマイルストーンのみを返します。ISO 8601 フォーマット (2019-03-15T08:00:00Z) で期待されます。GitLab 15.10 で導入。
updated_afterdatetimeいいえ指定した日時以降に更新されたマイルストーンのみを返します。ISO 8601 フォーマット (2019-03-15T08:00:00Z) で期待されます。GitLab 15.10 で導入。
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整数/文字列yes認証ユーザーが所有するグループのIDまたはURLエンコードされたパス
milestone_id整数。yesマイルストーンのグループID

マイルストーンの新規作成

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

POST /groups/:id/milestones

パラメータを指定します:

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

マイルストーンの編集

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

PUT /groups/:id/milestones/:milestone_id

パラメータを指定します:

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

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

グループの開発者ロールを持つユーザーのみ。

DELETE /groups/:id/milestones/:milestone_id

パラメータを指定します:

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

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

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

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

パラメータを指定します:

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

現在、このAPIエンドポイントはサブグループのイシューを返しません。すべてのマイルストーンのイシューを取得したい場合は、代わりにList issues APIを使用し、特定のマイルストーン (例えばGET /issues?milestone=1.0.0&state=opened) でフィルタリングすることができます。

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

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

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

パラメータを指定します:

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

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

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

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

パラメータを指定します:

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