プロジェクトイテレーション

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

このページでは、プロジェクトイテレーションについて説明します。別のグループイテレーションページがあります。

プロジェクトレベルのイテレーションはなくなりましたが、このエンドポイントを使用して、プロジェクトの祖先グループのイテレーションをフェッチできます。

プロジェクトイテレーションをリスト表示

プロジェクトイテレーションのリストを返します。

イテレーションケイデンスの自動スケジュールを有効にするによって作成されたイテレーションは、titleフィールドとdescriptionフィールドに対してnullを返します。

GET /projects/:id/iterations
GET /projects/:id/iterations?state=opened
GET /projects/:id/iterations?state=closed
GET /projects/:id/iterations?search=version
GET /projects/:id/iterations?include_ancestors=false
GET /projects/:id/iterations?include_descendants=true
GET /projects/:id/iterations?updated_before=2013-10-02T09%3A24%3A18Z
GET /projects/:id/iterations?updated_after=2013-10-02T09%3A24%3A18Z

属性	型	必須	説明
`state`	文字列	いいえ	「`opened`」、「`upcoming`」、「`current`」、「`closed`」、または「`all`」イテレーションを返します。
`search`	文字列	いいえ	指定された文字列と一致するタイトルを持つイテレーションのみを返します。
`in`	文字列の配列	いいえ	引数`search`で指定されたクエリを使用してあいまい検索を実行するフィールド。使用可能なオプションは、`title`と`cadence_title`です。デフォルトは`[title]`です。GitLab 16.2で導入されました。
`include_ancestors`	ブール値	いいえ	親グループとその祖先のイテレーションを含めます。`true`がデフォルトです。
`include_descendants`	ブール値	いいえ	親グループとその子孫のイテレーションを含めます。`false`がデフォルトです。GitLab 16.7で導入されました。
`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 --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/iterations"

レスポンス例:

[
  {
    "id": 53,
    "iid": 13,
    "group_id": 5,
    "title": "Iteration II",
    "description": "Ipsum Lorem ipsum",
    "state": 2,
    "created_at": "2020-01-27T05:07:12.573Z",
    "updated_at": "2020-01-27T05:07:12.573Z",
    "due_date": "2020-02-01",
    "start_date": "2020-02-14",
    "web_url": "http://gitlab.example.com/groups/my-group/-/iterations/13"
  }
]