그룹 마일스톤 API

Tier: Free(무료), Premium(프리미엄), Ultimate(얼티메이트) Offering: GitLab.com, Self-managed, GitLab Dedicated

REST API를 사용하여 그룹 마일스톤을 활용합니다. 별도의 프로젝트 마일스톤 API 페이지도 있습니다.

그룹 마일스톤 목록

그룹 마일스톤의 목록을 반환합니다. 

GET /groups/:id/milestones
GET /groups/:id/milestones?iids[]=42
GET /groups/:id/milestones?iids[]=42&iids[]=43
GET /groups/:id/milestones?state=active
GET /groups/:id/milestones?state=closed
GET /groups/:id/milestones?title=1.0
GET /groups/:id/milestones?search=version
GET /groups/:id/milestones?search_title=17.3+17.4
GET /groups/:id/milestones?search_title=17.3%2017.4
GET /groups/:id/milestones?updated_before=2013-10-02T09%3A24%3A18Z
GET /groups/:id/milestones?updated_after=2013-10-02T09%3A24%3A18Z
GET /groups/:id/milestones?containing_date=2013-10-02T09%3A24%3A18Z
GET /groups/:id/milestones?start_date=2013-10-02T09%3A24%3A18Z&end_date=2013-11-02T09%3A24%3A18Z

매개변수:

속성 유형 필수 설명
id 정수/문자열 예 그룹의 ID 또는 URL-인코딩된 경로.
iids[] 정수 배열 아니요 주어진 iid를 가진 마일스톤만 반환합니다. include_ancestors가 true인 경우 무시됩니다.
state 문자열 아니요 active 또는 closed 상태의 마일스톤만 반환합니다.
title 문자열 아니요 주어진 title을 가진 마일스톤만 반환합니다(대소문자 구분).
search 문자열 아니요 제공된 문자열과 일치하는 제목이나 설명을 가진 마일스톤만 반환합니다(대소문자 구분 없음).
search_title 문자열 아니요 제공된 문자열과 일치하는 제목을 가진 마일스톤만 반환합니다(대소문자 구분 없음). + 또는 %20로 이스케이프된 공백으로 구분된 여러 용어를 제공할 수 있으며, 모두 AND로 연결됩니다. 예: 17.4+17.5는 17.4와 17.5의 부분 문자열과 일치합니다(순서에 무관). GitLab 11.8에서 도입되었습니다.
include_parent_milestones 불리언 아니요 GitLab 16.7에서 폐기됨. 대신 include_ancestors를 사용하세요.
include_ancestors 불리언 아니요 모든 상위 그룹의 마일스톤을 포함합니다.
include_descendants 불리언 아니요 그룹 및 하위 그룹의 마일스톤을 포함합니다. 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에서 도입되었습니다.
containing_date 날짜 및 시간 아니요 start_date <= containing_date <= due_date인 마일스톤만 반환합니다. ISO 8601 형식(2019-03-15T08:00:00Z)으로 예상됩니다. GitLab 13.5에서 도입되었습니다.
start_date 날짜 및 시간 아니요 due_date >=로 제공된 start_date에 해당하는 마일스톤만 반환합니다. ISO 8601 형식(2019-03-15T08:00:00Z)으로 예상됩니다. 참고: end_date도 함께 제공된 경우에만 유효합니다. GitLab 12.8에서 도입되었습니다.
end_date 날짜 및 시간 아니요 start_date <=로 제공된 end_date에 해당하는 마일스톤만 반환합니다. ISO 8601 형식(2019-03-15T08:00:00Z)으로 예상됩니다. 참고: start_date도 함께 제공된 경우에만 유효합니다. GitLab 12.8에서 도입되었습니다. 
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/milestones"

응답 예시: 

[
  {
    "id": 12,
    "iid": 3,
    "group_id": 16,
    "title": "10.0",
    "description": "Version",
    "due_date": "2013-11-29",
    "start_date": "2013-11-10",
    "state": "active",
    "updated_at": "2013-10-02T09:24:18Z",
    "created_at": "2013-10-02T09:24:18Z",
    "expired": false,
    "web_url": "https://gitlab.com/groups/gitlab-org/-/milestones/42"
  }
]

단일 마일스톤 가져오기

단일 그룹 마일스톤을 가져옵니다. 

GET /groups/:id/milestones/:milestone_id

매개변수:

속성 유형 필수 설명
id 정수/문자열 예 그룹의 ID 또는 URL-인코딩된 경로
milestone_id 정수 예 그룹 마일스톤의 ID

새로운 마일스톤 생성

새로운 그룹 마일스톤을 생성합니다. 

POST /groups/:id/milestones

매개변수:

속성 유형 필수 설명
id 정수/문자열 예 그룹의 ID 또는 URL 인코딩된 경로
title 문자열 예 마일스톤의 제목
description 문자열 아니요 마일스톤의 설명
due_date 날짜 아니요 마일스톤의 마감일, ISO 8601 형식 (YYYY-MM-DD)
start_date 날짜 아니요 마일스톤의 시작일, ISO 8601 형식 (YYYY-MM-DD)

마일스톤 편집

기존의 그룹 마일스톤을 업데이트합니다. 

PUT /groups/:id/milestones/:milestone_id

매개변수:

속성 유형 필수 설명
id 정수/문자열 예 그룹의 ID 또는 URL 인코딩된 경로
milestone_id 정수 예 그룹 마일스톤의 ID
title 문자열 아니요 마일스톤의 제목
description 문자열 아니요 마일스톤의 설명
due_date 날짜 아니요 마일스톤의 마감일, ISO 8601 형식 (YYYY-MM-DD)
start_date 날짜 아니요 마일스톤의 시작일, ISO 8601 형식 (YYYY-MM-DD)
state_event 문자열 아니요 마일스톤의 상태 이벤트 (close 또는 activate)

그룹 마일스톤 삭제

그룹의 개발자 역할을 가진 사용자 전용입니다. 

DELETE /groups/:id/milestones/:milestone_id

매개변수:

속성 유형 필수 설명
id 정수/문자열 예 그룹의 ID 또는 URL 인코딩된 경로
milestone_id 정수 예 그룹 마일스톤의 ID

단일 마일스톤에 할당된 모든 이슈 가져오기

단일 그룹 마일스톤에 할당된 모든 이슈를 가져옵니다. 

GET /groups/:id/milestones/:milestone_id/issues

매개변수:

속성 유형 필수 설명
id 정수/문자열 예 그룹의 ID 또는 URL 인코딩된 경로
milestone_id 정수 예 그룹 마일스톤의 ID

현재 이 API 엔드포인트는 하위 그룹에서의 이슈를 반환하지 않습니다. 모든 마일스톤의 이슈를 가져오려면 대신 이슈 목록 API를 사용하고 특정 마일스톤을 필터링하십시오 (예: GET /issues?milestone=1.0.0&state=opened).

단일 마일스톤에 할당된 모든 병합 요청 가져오기

단일 그룹 마일스톤에 할당된 모든 병합 요청을 가져옵니다. 

GET /groups/:id/milestones/:milestone_id/merge_requests

매개변수:

속성 유형 필수 설명
id 정수/문자열 예 그룹의 ID 또는 URL 인코딩된 경로
milestone_id 정수 예 그룹 마일스톤의 ID

단일 마일스톤에 대한 모든 번다운 차트 이벤트 가져오기

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

단일 마일스톤에 대한 모든 번다운 차트 이벤트를 가져옵니다. 

GET /groups/:id/milestones/:milestone_id/burndown_events

매개변수:

속성 유형 필수 설명
id 정수/문자열 예 그룹의 ID 또는 URL 인코딩된 경로
milestone_id 정수 예 그룹 마일스톤의 ID