リソースマイルストーンイベントAPI

GitLab 13.1で導入されました。

リソースのマイルストーンイベントは、GitLabのイシューや マージリクエストに何が起こったかを追跡します。

どのマイルストーンが追加・削除されたか、誰が行ったか、いつ行われたかを追跡するのに使います。

イシュー

プロジェクト課題のマイルストーンイベントをリストアップします。

1つのイシューに関するすべてのマイルストーン・イベントの一覧を取得します。

GET /projects/:id/issues/:issue_iid/resource_milestone_events
属性種類必須説明
id整数/文字列yes プロジェクトのIDまたはURLエンコードされたパス
issue_iid整数。yesイシューのIID

リクエストの例

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/issues/11/resource_milestone_events"

応答例

[
  {
    "id": 142,
    "user": {
      "id": 1,
      "name": "Administrator",
      "username": "root",
      "state": "active",
      "avatar_url": "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
      "web_url": "http://gitlab.example.com/root"
    },
    "created_at": "2018-08-20T13:38:20.077Z",
    "resource_type": "Issue",
    "resource_id": 253,
    "milestone":   {
      "id": 61,
      "iid": 9,
      "project_id": 7,
      "title": "v1.2",
      "description": "Ipsum Lorem",
      "state": "active",
      "created_at": "2020-01-27T05:07:12.573Z",
      "updated_at": "2020-01-27T05:07:12.573Z",
      "due_date": null,
      "start_date": null,
      "web_url": "http://gitlab.example.com:3000/group/project/-/milestones/9"
    },
    "action": "add"
  },
  {
    "id": 143,
    "user": {
      "id": 1,
      "name": "Administrator",
      "username": "root",
      "state": "active",
      "avatar_url": "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
      "web_url": "http://gitlab.example.com/root"
    },
    "created_at": "2018-08-21T14:38:20.077Z",
    "resource_type": "Issue",
    "resource_id": 253,
    "milestone":   {
      "id": 61,
      "iid": 9,
      "project_id": 7,
      "title": "v1.2",
      "description": "Ipsum Lorem",
      "state": "active",
      "created_at": "2020-01-27T05:07:12.573Z",
      "updated_at": "2020-01-27T05:07:12.573Z",
      "due_date": null,
      "start_date": null,
      "web_url": "http://gitlab.example.com:3000/group/project/-/milestones/9"
    },
    "action": "remove"
  }
]

単一のイシュー・マイルストーン・イベントの取得

特定のプロジェクト課題のマイルストーン・イベントを返します。

GET /projects/:id/issues/:issue_iid/resource_milestone_events/:resource_milestone_event_id

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

属性種類必須説明
id整数/文字列yesプロジェクトのIDまたはURLエンコードされたパス
issue_iid整数。yesイシューのIID
resource_milestone_event_id整数。yesマイルストーンイベントのID

リクエストの例

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/issues/11/resource_milestone_events/1"

マージリクエスト

プロジェクトマージリクエストのマイルストーンイベントを一覧表示します。

ひとつのマージリクエストのすべてのマイルストーンイベントの一覧を取得します。

GET /projects/:id/merge_requests/:merge_request_iid/resource_milestone_events
属性種類必須説明
id整数/文字列yesプロジェクトのIDまたはURLエンコードされたパス
merge_request_iid整数。yesマージリクエストの IID

リクエストの例

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/resource_milestone_events"

応答例

[
  {
    "id": 142,
    "user": {
      "id": 1,
      "name": "Administrator",
      "username": "root",
      "state": "active",
      "avatar_url": "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
      "web_url": "http://gitlab.example.com/root"
    },
    "created_at": "2018-08-20T13:38:20.077Z",
    "resource_type": "MergeRequest",
    "resource_id": 142,
    "milestone":   {
      "id": 61,
      "iid": 9,
      "project_id": 7,
      "title": "v1.2",
      "description": "Ipsum Lorem",
      "state": "active",
      "created_at": "2020-01-27T05:07:12.573Z",
      "updated_at": "2020-01-27T05:07:12.573Z",
      "due_date": null,
      "start_date": null,
      "web_url": "http://gitlab.example.com:3000/group/project/-/milestones/9"
    },
    "action": "add"
  },
  {
    "id": 143,
    "user": {
      "id": 1,
      "name": "Administrator",
      "username": "root",
      "state": "active",
      "avatar_url": "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
      "web_url": "http://gitlab.example.com/root"
    },
    "created_at": "2018-08-21T14:38:20.077Z",
    "resource_type": "MergeRequest",
    "resource_id": 142,
    "milestone":   {
      "id": 61,
      "iid": 9,
      "project_id": 7,
      "title": "v1.2",
      "description": "Ipsum Lorem",
      "state": "active",
      "created_at": "2020-01-27T05:07:12.573Z",
      "updated_at": "2020-01-27T05:07:12.573Z",
      "due_date": null,
      "start_date": null,
      "web_url": "http://gitlab.example.com:3000/group/project/-/milestones/9"
    },
    "action": "remove"
  }
]

単一のマージリクエストマイルストーンイベントの取得

特定のプロジェクトのマージリクエストのマイルストーンイベントを返します。

GET /projects/:id/merge_requests/:merge_request_iid/resource_milestone_events/:resource_milestone_event_id

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

属性種類必須説明
id整数/文字列yes プロジェクトのIDまたはURLエンコードされたパス
merge_request_iid整数。yesマージリクエストの IID
resource_milestone_event_id整数。yesマイルストーンイベントのID

リクエストの例

curl --request GET --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/resource_milestone_events/120"