프로젝트 이터레이션 API

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

이 페이지에서는 프로젝트 이터레이션 API에 대해 설명합니다. 별도의 그룹 이터레이션 API 페이지가 있습니다.

GitLab 13.5부터 프로젝트 레벨의 이터레이션이 없지만, 이 엔드포인트를 사용하여 프로젝트의 상위 그룹의 이터레이션을 가져올 수 있습니다.

프로젝트 이터레이션 목록

프로젝트 이터레이션의 목록을 반환합니다.

이터레이션 주기에서 자동 스케줄링 활성화로 생성된 이터레이션은 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 문자열 아니오 ’ opened, upcoming, current, closed, 또는 all 이터레이션을 반환합니다.’
search 문자열 아니오 제공된 문자열과 일치하는 제목을 가진 이터레이션만 반환합니다.
in 문자열 배열 아니오 퍼지 검색이 수행될 필드와 주어진 쿼리를 사용하여 수행할 필드입니다. 사용 가능한 옵션은 title 및 cadence_title입니다. 기본값은 [title]입니다. GitLab 16.2에서 도입되었습니다.
include_ancestors 부울 아니오 상위 그룹과 해당 조상에 대한 이터레이션을 포함합니다. 기본값은 true입니다.
include_descendants 부울 아니오 상위 그룹 및 해당 하위에 대한 이터레이션을 포함합니다. 기본값은 false입니다. GitLab 16.7에서 도입되었습니다.
updated_before 날짜 및 시간 아니오 주어진 날짜 및 시간 이전에 업데이트된 이터레이션만 반환합니다. ISO 8601 형식(2019-03-15T08:00:00Z)으로 입력합니다. GitLab 15.10에서 도입되었습니다.
updated_after 날짜 및 시간 아니오 주어진 날짜 및 시간 이후에 업데이트된 이터레이션만 반환합니다. 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"
  }
]