그룹 레이블 API

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

이 API는 그룹 레이블을 관리하는 데 도움이 됩니다. 사용자는 그룹 레이블을 나열하고, 만들고, 업데이트하고, 삭제할 수 있습니다. 더불어, 사용자는 그룹 레이블을 구독하거나 구독 취소할 수 있습니다.

그룹 레이블 나열

지정된 그룹에 대한 모든 레이블을 가져옵니다.

GET /groups/:id/labels

속성	유형	필수	설명
`id`	정수/문자열	예	그룹의 ID 또는 URL 인코딩된 경로
`with_counts`	부울	아니요	이슈 및 병합 요청 수를 포함할지 여부입니다. 기본값은 `false`입니다.
`include_ancestor_groups`	부울	아니요	조상 그룹을 포함할지 여부입니다. 기본값은 `true`입니다.
`include_descendant_groups`	부울	아니요	자손 그룹을 포함할지 여부입니다. 기본값은 `false`입니다.
`only_group_labels`	부울	아니요	그룹 레이블만 포함할지 또는 프로젝트 레이블도 포함할지 토글합니다. 기본값은 `true`입니다.
`search`	문자열	아니요	레이블을 필터링하는 데 사용되는 키워드입니다.

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/labels?with_counts=true"

예시 응답:

[
  {
    "id": 7,
    "name": "bug",
    "color": "#FF0000",
    "text_color" : "#FFFFFF",
    "description": null,
    "description_html": null,
    "open_issues_count": 0,
    "closed_issues_count": 0,
    "open_merge_requests_count": 0,
    "subscribed": false
  },
  {
    "id": 4,
    "name": "feature",
    "color": "#228B22",
    "text_color" : "#FFFFFF",
    "description": null,
    "description_html": null,
    "open_issues_count": 0,
    "closed_issues_count": 0,
    "open_merge_requests_count": 0,
    "subscribed": false
  }
]

단일 그룹 레이블 가져오기

지정된 그룹에 대한 단일 레이블을 가져옵니다.

GET /groups/:id/labels/:label_id

속성	유형	필수	설명
`id`	정수 또는 문자열	예	그룹의 ID 또는 URL 인코딩된 경로
`label_id`	정수 또는 문자열	예	그룹 레이블의 ID 또는 제목입니다.
`include_ancestor_groups`	부울	아니요	조상 그룹을 포함할지 여부입니다. 기본값은 `true`입니다.
`include_descendant_groups`	부울	아니요	자손 그룹을 포함할지 여부입니다. 기본값은 `false`입니다.
`only_group_labels`	부울	아니요	그룹 레이블만 포함할지 또는 프로젝트 레이블도 포함할지 토글합니다. 기본값은 `true`입니다.

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

예시 응답:

{
  "id": 7,
  "name": "bug",
  "color": "#FF0000",
  "text_color" : "#FFFFFF",
  "description": null,
  "description_html": null,
  "open_issues_count": 0,
  "closed_issues_count": 0,
  "open_merge_requests_count": 0,
  "subscribed": false
}

새 그룹 레이블 생성

지정된 그룹에 새로운 그룹 레이블을 만듭니다.

POST /groups/:id/labels

속성	유형	필수	설명
`id`	정수/문자열	예	그룹의 ID 또는 URL 인코딩된 경로
`name`	문자열	예	레이블의 이름
`color`	문자열	예	레이블의 색상으로, 앞에 ‘#’ 기호가 있는 6자리 16진수 표기법(예: #FFAABB) 또는 CSS 색상 이름 중 하나입니다.
`description`	문자열	아니요	레이블의 설명

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --header "Content-Type: application/json" \
     --data '{"name": "Feature Proposal", "color": "#FFA500", "description": "새로운 아이디어를 묘사합니다" }' \
     "https://gitlab.example.com/api/v4/groups/5/labels"

예시 응답:

{
  "id": 9,
  "name": "Feature Proposal",
  "color": "#FFA500",
  "text_color" : "#FFFFFF",
  "description": "새로운 아이디어를 묘사합니다",
  "description_html": "새로운 아이디어를 묘사합니다",
  "open_issues_count": 0,
  "closed_issues_count": 0,
  "open_merge_requests_count": 0,
  "subscribed": false
}

그룹 레이블 업데이트

기존의 그룹 레이블을 업데이트합니다. 그룹 레이블을 업데이트하려면 하나 이상의 매개변수가 필요합니다.

PUT /groups/:id/labels/:label_id

속성	유형	필수	설명
`id`	정수 또는 문자열	예	그룹의 ID 또는 URL 인코딩된 경로
`label_id`	정수 또는 문자열	예	그룹 레이블의 ID 또는 제목입니다.
`new_name`	문자열	아니요	레이블의 새 이름
`color`	문자열	아니요	레이블의 색상으로, 앞에 ‘#’ 기호가 있는 6자리 16진수 표기법(예: #FFAABB) 또는 CSS 색상 이름 중 하나입니다.
`description`	문자열	아니요	레이블의 설명

curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" --header "Content-Type: application/json" \
     --data '{"new_name": "Feature Idea" }' "https://gitlab.example.com/api/v4/groups/5/labels/Feature%20Proposal"

예시 응답:

{
  "id": 9,
  "name": "Feature Idea",
  "color": "#FFA500",
  "text_color" : "#FFFFFF",
  "description": "새로운 아이디어를 묘사합니다",
  "description_html": "새로운 아이디어를 묘사합니다",
  "open_issues_count": 0,
  "closed_issues_count": 0,
  "open_merge_requests_count": 0,
  "subscribed": false
}

name을 매개변수로 사용하는 이전 엔드포인트 PUT /groups/:id/labels도 사용할 수 있지만, 더 이상 지원되지 않습니다.

그룹 라벨 삭제

지정된 이름의 그룹 라벨을 삭제합니다.

DELETE /groups/:id/labels/:label_id

속성	유형	필수	설명
`id`	integer 또는 string	예	그룹의 ID 또는 URL-encoded path
`label_id`	integer 또는 string	예	그룹 라벨의 ID 또는 제목

curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/labels/bug"

참고: 매개변수 name이 포함된 이전 엔드포인트 DELETE /groups/:id/labels는 사용 가능하지만 폐지 예정입니다.

그룹 라벨 구독

인증된 사용자가 그룹 라벨을 구독하여 알림을 받게 됩니다. 사용자가 이미 라벨을 구독한 경우 상태 코드 304가 반환됩니다.

POST /groups/:id/labels/:label_id/subscribe

속성	유형	필수	설명
`id`	integer 또는 string	예	그룹의 ID 또는 URL-encoded path
`label_id`	integer 또는 string	예	그룹 라벨의 ID 또는 제목

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/labels/9/subscribe"

예시 응답:

{
  "id": 9,
  "name": "Feature Idea",
  "color": "#FFA500",
  "text_color" : "#FFFFFF",
  "description": "새로운 아이디어를 설명합니다",
  "description_html": "새로운 아이디어를 설명합니다",
  "open_issues_count": 0,
  "closed_issues_count": 0,
  "open_merge_requests_count": 0,
  "subscribed": true
}

그룹 라벨 구독 취소

인증된 사용자가 그룹 라벨의 알림을 더 이상 받지 않도록 그룹 라벨의 구독을 취소합니다. 사용자가 라벨을 구독하지 않은 경우 상태 코드 304가 반환됩니다.

POST /groups/:id/labels/:label_id/unsubscribe

속성	유형	필수	설명
`id`	integer 또는 string	예	그룹의 ID 또는 URL-encoded path
`label_id`	integer 또는 string	예	그룹 라벨의 ID 또는 제목

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/labels/9/unsubscribe"

예시 응답:

{
  "id": 9,
  "name": "Feature Idea",
  "color": "#FFA500",
  "text_color" : "#FFFFFF",
  "description": "새로운 아이디어를 설명합니다",
  "description_html": "새로운 아이디어를 설명합니다",
  "open_issues_count": 0,
  "closed_issues_count": 0,
  "open_merge_requests_count": 0,
  "subscribed": false
}

그룹 레이블 API

그룹 레이블 나열

단일 그룹 레이블 가져오기

새 그룹 레이블 생성

그룹 레이블 업데이트

그룹 라벨 삭제

그룹 라벨 구독

그룹 라벨 구독 취소

도움말

기능 사용 가능성과 제품 평가판

도움받기