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

プラン: Free、Premium、Ultimate
提供形態: GitLab.com、GitLab Self-Managed、GitLab Dedicated

グループマイルストーンについては、グループマイルストーン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>" \
  --url "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`	文字列	いいえ	マイルストーンの状態イベント（クローズまたはアクティブ化）

マイルストーンを削除する

指定されたプロジェクトマイルストーンを削除します。

プロジェクトのプランナー、レポーター、デベロッパー、メンテナー、またはオーナーロールを持つユーザーのみが対象です。

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

マイルストーンをグループマイルストーンにプロモート

プロジェクトマイルストーンをグループマイルストーンにプロモートします。

グループのプランナー、レポーター、デベロッパー、メンテナー、またはオーナーロールを持つユーザーのみが対象です。

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

パラメータは以下のとおりです:

属性	型	必須	説明
`id`	整数または文字列	はい	プロジェクトのIDまたはURLエンコードされたパス
`milestone_id`	整数	はい	プロジェクトのマイルストーンのID

マイルストーンのすべてのバーンダウンチャートイベントを一覧表示

プラン: Premium、Ultimate
提供形態: GitLab.com、GitLab Self-Managed、GitLab Dedicated

指定されたマイルストーンのすべてのバーンダウンチャートイベントを一覧表示します。

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

パラメータは以下のとおりです:

属性	型	必須	説明
`id`	整数または文字列	はい	プロジェクトのIDまたはURLエンコードされたパス
`milestone_id`	整数	はい	プロジェクトのマイルストーンのID