群组迭代 API

该页面描述群组迭代 API。您还可以阅读项目迭代 API 页面。

列出群组迭代

返回群组迭代列表。

在迭代节奏中通过 启用自动计划创建的迭代返回 null 的 title 和 description 字段。

GET /groups/:id/iterations
GET /groups/:id/iterations?state=opened
GET /groups/:id/iterations?state=closed
GET /groups/:id/iterations?search=version
GET /groups/:id/iterations?include_ancestors=false
GET /groups/:id/iterations?include_descendants=true
GET /groups/:id/iterations?updated_before=2013-10-02T09%3A24%3A18Z
GET /groups/:id/iterations?updated_after=2013-10-02T09%3A24%3A18Z
参数 类型 是否必需 描述
state string no 返回 opened、upcoming、current (previously started)、closed 或 all 迭代。从 14.1 开始，通过 started 状态进行筛选已经废弃，请使用 current
search string no 仅返回标题匹配提供的资源串的迭代
in array of strings no 在这些字段中，应该使用参数 search 中给定的查询进行模糊搜索。可用的选项时 title 和 cadence_title。默认为 [title]。自极狐GitLab 16.2 引入。
include_ancestors boolean no 包括来自父群组及其祖先群组的迭代。默认为 true
include_descendants boolean no 包括组及其子群组的迭代。 默认为 false。自极狐GitLab 16.7 引入。
updated_before datetime no 仅返回给定日期时间之前更新的迭代。预计格式为 ISO 8601（2019-03-15T08:00:00Z）。引入于 15.10
updated_after datetime no 仅返回给定日期时间之后更新的迭代。预计格式为 ISO ISO 8601（2019-03-15T08:00:00Z）。引入于 15.10

请求示例：

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/iterations"

响应示例：

[
  {
    "id": 53,
    "iid": 13,
    "sequence": 1,
    "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"
  }
]