프로젝트 이터레이션 API
Tier: Premium, Ultimate
Offering: GitLab.com, Self-Managed, GitLab Dedicated
이 페이지는 프로젝트 이터레이션 API에 대해 설명합니다. 별도의 그룹 이터레이션 API 페이지가 있습니다.
프로젝트 이터레이션 디렉터리
프로젝트 이터레이션 디렉터리을 반환합니다.
자동 일정 설정 활성화에 의해 생성된 이터레이션 주기는 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
| string | 아니오 | ‘오픈된(iterations), 예정된(upcoming), 현재(current), 닫힌(closed), 또는 모든(all) iterations를 반환.’ |
search
| string | 아니오 | 제공된 문자열과 일치하는 제목을 가진 이터레이션만 반환합니다. |
in
| 문자열의 배열 | 아니오 | 흐릿한 검색이 수행될 필드 및 제공된 query로의 fuzzy 검색이 수행되어야 하는 배열입니다. 사용 가능한 옵션은 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/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"
}
]