Help us learn about your current experience with the documentation. Take the survey.

组迭代 API

Tier: Premium, Ultimate
Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated

本页面介绍组迭代 API。另有单独的项目迭代 API页面。

列出组迭代

返回组迭代列表。

在迭代节奏中通过启用自动调度创建的迭代，其 title 和 description 字段将返回 null。

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	否	‘返回 `opened`（已开启）、`upcoming`（即将开始）、`current`（当前）、`closed`（已关闭）或 `all`（全部）的迭代。’
`search`	string	否	仅返回标题与提供的字符串匹配的迭代。
`in`	字符串数组	否	使用 `search` 参数中提供的查询进行模糊搜索的字段。可用选项为 `title` 和 `cadence_title`。默认为 `[title]`。GitLab 16.2 中引入。
`include_ancestors`	boolean	否	包含该组及其祖先组的迭代。默认为 `true`。
`include_descendants`	boolean	否	包含该组及其后代组的迭代。默认为 `false`。GitLab 16.7 中引入。
`updated_before`	datetime	否	仅返回在给定日期时间之前更新的迭代。预期格式为 ISO 8601 (`2019-03-15T08:00:00Z`)。GitLab 15.10 中引入。
`updated_after`	datetime	否	仅返回在给定日期时间之后更新的迭代。预期格式为 ISO 8601 (`2019-03-15T08:00:00Z`)。GitLab 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"
  }
]