正式なドキュメントは英語版であり、この日本語訳はAI支援翻訳により作成された参考用のものです。日本語訳の一部の内容は人間によるレビューがまだ行われていないため、翻訳のタイミングにより英語版との間に差異が生じることがあります。最新かつ正確な情報については、英語版をご参照ください。

グループラベルAPI

  • プラン: Free、Premium、Ultimate
  • 提供形態: GitLab.com、GitLab Self-Managed、GitLab Dedicated

このAPIを使用して、グループラベルを管理します。

プロジェクトラベルには、プロジェクトラベルAPIを使用します。

グループラベルの一覧表示

指定されたグループのすべてのラベルを取得します。

GET /groups/:id/labels
属性型必須説明
id整数または文字列はいグループのIDまたはURLエンコードされたパス。
with_countsブール値いいえイシューとマージリクエストの数を含めるかどうか。falseがデフォルトです。
include_ancestor_groupsブール値いいえ祖先グループを含めます。trueがデフォルトです。
include_descendant_groupsブール値いいえ子孫グループを含めます。falseがデフォルトです。
only_group_labelsブール値いいえグループラベルのみを含めるか、プロジェクトラベルも一緒に含めるかの切替。trueがデフォルトです。
search文字列いいえラベルでフィルタリングするキーワード。
archivedブール値いいえtrueの場合、アーカイブされたラベルのみを返します。設定されていない場合、すべてのラベルを返します。
curl \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "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,
    "archived": 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,
    "archived": 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>" \
  --url "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,
  "archived": false
}

新しいグループラベルを作成

指定されたグループの新しいグループラベルを作成します。

POST /groups/:id/labels
属性型必須説明
id整数または文字列はいグループのIDまたはURLエンコードされたパス
name文字列はいラベルの名前
color文字列はいラベルの色。先頭に「#」が付いた6桁の16進表記（例: #FFAABB）またはCSSカラー名のいずれかで指定します。
description文字列いいえラベルの説明、
archivedブール値いいえtrueの場合、ラベルをアーカイブ済みとしてマークします。デフォルト値: false。デフォルト値: false。
curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --header "Content-Type: application/json" \
  --data '{
    "name": "Feature Proposal",
    "color": "#FFA500",
    "description": "Describes new ideas"
  }' \
  --url "https://gitlab.example.com/api/v4/groups/5/labels"

レスポンス例:

{
  "id": 9,
  "name": "Feature Proposal",
  "color": "#FFA500",
  "text_color" : "#FFFFFF",
  "description": "Describes new ideas",
  "description_html": "Describes new ideas",
  "open_issues_count": 0,
  "closed_issues_count": 0,
  "open_merge_requests_count": 0,
  "subscribed": false,
  "archived": false
}

グループラベルを更新

既存のグループラベルを更新します。グループラベルを更新するには、少なくとも1つのパラメータが必要です。

PUT /groups/:id/labels/:label_id
属性型必須説明
id整数または文字列はいグループのIDまたはURLエンコードされたパス
label_id整数または文字列はいグループのラベルのIDまたはタイトル。
new_name文字列いいえラベルの新しい名前
color文字列いいえラベルの色。先頭に「#」が付いた6桁の16進表記（例: #FFAABB）またはCSSカラー名のいずれかで指定します。
description文字列いいえラベルの説明。
archivedブール値いいえtrueの場合、ラベルをアーカイブ済みとしてマークします。デフォルト値: false。デフォルト値: false。
curl --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --header "Content-Type: application/json" \
  --data '{"new_name": "Feature Idea"}' \
  --url "https://gitlab.example.com/api/v4/groups/5/labels/Feature%20Proposal"

レスポンス例:

{
  "id": 9,
  "name": "Feature Idea",
  "color": "#FFA500",
  "text_color" : "#FFFFFF",
  "description": "Describes new ideas",
  "description_html": "Describes new ideas",
  "open_issues_count": 0,
  "closed_issues_count": 0,
  "open_merge_requests_count": 0,
  "subscribed": false,
  "archived": false
}

古いエンドポイントPUT /groups/:id/labels (パラメータにnameを含む) は引き続き利用可能ですが、非推奨です。

グループラベルを削除

指定された名前のグループラベルを削除します。

DELETE /groups/:id/labels/:label_id
属性型必須説明
id整数または文字列はいグループのIDまたはURLエンコードされたパス
label_id整数または文字列はいグループのラベルのIDまたはタイトル。
curl --request DELETE \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/5/labels/bug"

古いエンドポイントDELETE /groups/:id/labels (パラメータにnameを含む) は引き続き利用可能ですが、非推奨です。

グループラベルを購読

認証済みユーザーをグループラベルに登録し、通知を受け取ります。ユーザーがすでにラベルを購読している場合、ステータスコード304が返されます。

POST /groups/:id/labels/:label_id/subscribe
属性型必須説明
id整数または文字列はいグループのIDまたはURLエンコードされたパス
label_id整数または文字列はいグループのラベルのIDまたはタイトル。
curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/5/labels/9/subscribe"

レスポンス例:

{
  "id": 9,
  "name": "Feature Idea",
  "color": "#FFA500",
  "text_color" : "#FFFFFF",
  "description": "Describes new ideas",
  "description_html": "Describes new ideas",
  "open_issues_count": 0,
  "closed_issues_count": 0,
  "open_merge_requests_count": 0,
  "subscribed": true,
  "archived": false
}

グループラベルの購読解除

認証済みユーザーをグループラベルから登録解除し、それからの通知を受け取らないようにします。ユーザーがラベルを購読していない場合、ステータスコード304が返されます。

POST /groups/:id/labels/:label_id/unsubscribe
属性型必須説明
id整数または文字列はいグループのIDまたはURLエンコードされたパス
label_id整数または文字列はいグループのラベルのIDまたはタイトル。
curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/5/labels/9/unsubscribe"

レスポンス例:

{
  "id": 9,
  "name": "Feature Idea",
  "color": "#FFA500",
  "text_color" : "#FFFFFF",
  "description": "Describes new ideas",
  "description_html": "Describes new ideas",
  "open_issues_count": 0,
  "closed_issues_count": 0,
  "open_merge_requests_count": 0,
  "subscribed": false,
  "archived": false
}