プロジェクトのマイルストーン API

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整数または文字列。yes認証ユーザーが所有するプロジェクトのIDまたはURLエンコードされたパス
iids[]整数配列。いいえ指定されたiid を持つマイルストーンのみを返します (注意:include_parent_milestones がtrueに設定されている場合は無視されます)。
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/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整数または文字列。yes認証ユーザーが所有するプロジェクトのIDまたはURLエンコードされたパス
milestone_id整数。yesプロジェクトのマイルストーンのID

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

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

POST /projects/:id/milestones

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

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

マイルストーンの編集

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

PUT /projects/:id/milestones/:milestone_id

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

属性種類必須説明
id整数または文字列。yes認証ユーザーが所有するプロジェクトのIDまたはURLエンコードされたパス
milestone_id整数。yesプロジェクトのマイルストーンのID
title文字列です。いいえマイルストーンのタイトル
description文字列です。いいえマイルストーンの説明
due_date文字列です。いいえマイルストーンの期日 (YYYY-MM-DD)
start_date文字列です。いいえマイルストーンの開始日 (YYYY-MM-DD)
state_event文字列です。いいえマイルストーンの状態イベント（クローズまたはアクティベート）

マイルストーンの削除

GitLab 15.0の最小ユーザーロールを開発者からレポーターに変更しました。

プロジェクトで少なくともレポーターロールを持つユーザーのみ。

DELETE /projects/:id/milestones/:milestone_id

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

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

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

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

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

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

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

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

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

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

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

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

プロジェクトのマイルストーンをグループのマイルストーンに昇格させます。

GitLab 15.0の最小ユーザーロールを開発者からレポーターに変更しました。

グループに少なくともレポーターのロールを持つユーザーのみ。

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

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

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

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

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

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

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

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