极狐 GitLab Logo

群组迭代 API

  • Tier: 专业版, 旗舰版
  • Offering: JihuLab.com, 私有化部署

本文描述了群组迭代 API。另有一个单独的项目迭代 API页面。

列出群组迭代#

返回群组迭代的列表。

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

plaintext
1GET /groups/:id/iterations
2GET /groups/:id/iterations?state=opened
3GET /groups/:id/iterations?state=closed
4GET /groups/:id/iterations?search=version
5GET /groups/:id/iterations?include_ancestors=false
6GET /groups/:id/iterations?include_descendants=true
7GET /groups/:id/iterations?updated_before=2013-10-02T09%3A24%3A18Z
8GET /groups/:id/iterations?updated_after=2013-10-02T09%3A24%3A18Z
属性类型必需描述
statestringno返回opened、upcoming、current、closed或all迭代。
searchstringno仅返回标题与提供的字符串匹配的迭代。
inarray of stringsno应在参数search中给出的查询中进行模糊搜索的字段。可用选项是title和cadence_title。默认值是[title]。在极狐GitLab 16.2 中引入。
include_ancestorsbooleanno包括群组及其祖先的迭代。默认值为true。
include_descendantsbooleanno包括群组及其后代的迭代。默认值为false。在极狐GitLab 16.7 中引入。
updated_beforedatetimeno仅返回在给定日期时间之前更新的迭代。需要以 ISO 8601 格式提供（2019-03-15T08:00:00Z）。在极狐GitLab 15.10 中引入。
updated_afterdatetimeno仅返回在给定日期时间之后更新的迭代。需要以 ISO 8601 格式提供（2019-03-15T08:00:00Z）。在极狐GitLab 15.10 中引入。

示例请求：

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

示例响应：

json
1[
2  {
3    "id": 53,
4    "iid": 13,
5    "sequence": 1,
6    "group_id": 5,
7    "title": "Iteration II",
8    "description": "Ipsum Lorem ipsum",
9    "state": 2,
10    "created_at": "2020-01-27T05:07:12.573Z",
11    "updated_at": "2020-01-27T05:07:12.573Z",
12    "due_date": "2020-02-01",
13    "start_date": "2020-02-14",
14    "web_url": "http://gitlab.example.com/groups/my-group/-/iterations/13"
15  }
16]