그룹 마일스톤 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?updated_before=2013-10-02T09%3A24%3A18Z
GET /groups/:id/milestones?updated_after=2013-10-02T09%3A24%3A18Z

매개변수:

속성 유형 필수 설명
id 정수/문자열 예 인증된 사용자가 소유한 그룹의 ID 또는 URL 인코딩된 경로
iids[] 정수 배열 아니요 주어진 iid를 가진 마일스톤만 반환합니다. include_ancestors가 true인 경우 무시됩니다.
state 문자열 아니요 active 또는 closed 상태의 마일스톤만 반환합니다.
title 문자열 아니요 주어진 title을 가진 마일스톤만 반환합니다.
search 문자열 아니요 제공된 문자열과 일치하는 제목 또는 설명을 가진 마일스톤만 반환합니다.
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에서 도입됨 
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)

그룹 마일스톤 삭제

그룹의 Developer 역할을 가진 사용자만 가능합니다. 

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).

단일 마일스톤에 할당된 모든 Merge Request 가져오기

단일 그룹 마일스톤에 할당된 모든 Merge Request을 가져옵니다. 

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