プロジェクト反復API

この Pages では、プロジェクトの反復 API について説明します。グループの反復 APIページは別にあります。

GitLab 13.5 現在、プロジェクトレベルのイテレーションはありませんが、このエンドポイントを使ってプロジェクトの祖先グループのイテレーションを取得することができます。

プロジェクトの反復処理の一覧

プロジェクトの反復処理のリストを返します。

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?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_ancestorsbooleanいいえ親グループとその祖先からの反復を含めます。デフォルトはtrue。
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/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"
  }
]