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

ラベルAPI

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

ラベルをREST APIで使用して操作します。

ラベルの一覧表示

特定のプロジェクトのすべてのラベルを取得します。

APIの結果はページネーションされるため、デフォルトでは、このリクエストは一度に20個の結果を返します。

GET /projects/:id/labels
属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス
with_countsブール値いいえイシューとマージリクエストの数を組み込むかどうか。falseがデフォルトです。
include_ancestor_groupsブール値いいえ祖先グループを含めます。trueがデフォルトです。
search文字列いいえラベルをフィルタリングするキーワード。
archivedブール値いいえラベルがアーカイブされているかどうか。設定されていない場合、すべてのラベルを返します。labels_archive機能フラグを有効にする必要があります。
curl \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/1/labels?with_counts=true"

レスポンス例:

[
  {
    "id" : 1,
    "name" : "bug",
    "color" : "#d9534f",
    "text_color" : "#FFFFFF",
    "description": "Bug reported by user",
    "description_html": "Bug reported by user",
    "open_issues_count": 1,
    "closed_issues_count": 0,
    "open_merge_requests_count": 1,
    "subscribed": false,
    "priority": 10,
    "is_project_label": true,
    "archived": false
  },
  {
    "id" : 4,
    "color" : "#d9534f",
    "text_color" : "#FFFFFF",
    "name" : "confirmed",
    "description": "Confirmed issue",
    "description_html": "Confirmed issue",
    "open_issues_count": 2,
    "closed_issues_count": 5,
    "open_merge_requests_count": 0,
    "subscribed": false,
    "priority": null,
    "is_project_label": true,
    "archived": false
  },
  {
    "id" : 7,
    "name" : "critical",
    "color" : "#d9534f",
    "text_color" : "#FFFFFF",
    "description": "Critical issue. Need fix ASAP",
    "description_html": "Critical issue. Need fix ASAP",
    "open_issues_count": 1,
    "closed_issues_count": 3,
    "open_merge_requests_count": 1,
    "subscribed": false,
    "priority": null,
    "is_project_label": true,
    "archived": false
  },
  {
    "id" : 8,
    "name" : "documentation",
    "color" : "#f0ad4e",
    "text_color" : "#FFFFFF",
    "description": "Issue about documentation",
    "description_html": "Issue about documentation",
    "open_issues_count": 1,
    "closed_issues_count": 0,
    "open_merge_requests_count": 2,
    "subscribed": false,
    "priority": null,
    "is_project_label": false,
    "archived": false
  },
  {
    "id" : 9,
    "color" : "#5cb85c",
    "text_color" : "#FFFFFF",
    "name" : "enhancement",
    "description": "Enhancement proposal",
    "description_html": "Enhancement proposal",
    "open_issues_count": 1,
    "closed_issues_count": 0,
    "open_merge_requests_count": 1,
    "subscribed": true,
    "priority": null,
    "is_project_label": true,
    "archived": false
  }
]

単一プロジェクトラベルを取得します

特定のプロジェクトの単一のラベルを取得します。

GET /projects/:id/labels/:label_id
属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス
label_id整数または文字列はいプロジェクトのラベルのIDまたはタイトル。
include_ancestor_groupsブール値いいえ祖先グループを含めます。trueがデフォルトです。
curl \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/1/labels/bug"

レスポンス例:

{
  "id" : 1,
  "name" : "bug",
  "color" : "#d9534f",
  "text_color" : "#FFFFFF",
  "description": "Bug reported by user",
  "description_html": "Bug reported by user",
  "open_issues_count": 1,
  "closed_issues_count": 0,
  "open_merge_requests_count": 1,
  "subscribed": false,
  "priority": 10,
  "is_project_label": true,
  "archived": false
}

新しいラベルを作成

指定されたリポジトリに、指定された名前と色で新しいラベルを作成します。

POST /projects/:id/labels
属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス
name文字列はいラベルの名前
color文字列はいラベルの色。先頭が「#」記号の6桁の16進数表記（#FFAABBなど）か、またはCSSカラー名のいずれかで指定。
description文字列いいえラベルの説明。
priority整数いいえラベルの優先度。優先度を削除するには、ゼロ以上またはnullにする必要があります。
archivedブール値いいえラベルがアーカイブされているかどうか。falseがデフォルトです。labels_archive機能フラグを有効にする必要があります。
curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/1/labels" \
  --data "name=feature&color=#5843AD"

レスポンス例:

{
  "id" : 10,
  "name" : "feature",
  "color" : "#5843AD",
  "text_color" : "#FFFFFF",
  "description":null,
  "description_html":null,
  "open_issues_count": 0,
  "closed_issues_count": 0,
  "open_merge_requests_count": 0,
  "subscribed": false,
  "priority": null,
  "is_project_label": true,
  "archived": false
}

ラベルを削除

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

DELETE /projects/: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/projects/1/labels/bug"

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

既存のラベルを編集

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

PUT /projects/:id/labels/:label_id
属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス
label_id整数または文字列はいグループのラベルのIDまたはタイトル。
new_name文字列はい（colorが指定されていない場合）ラベルの新しい名前
color文字列はい（new_nameが指定されていない場合）ラベルの色。先頭が「#」記号の6桁の16進数表記（#FFAABBなど）か、またはCSSカラー名のいずれかで指定。
description文字列いいえ新しいラベルの説明
priority整数いいえラベルの新しい優先度。優先度を削除するには、ゼロ以上またはnullにする必要があります。
archivedブール値いいえラベルがアーカイブされているかどうか。labels_archive機能フラグを有効にする必要があります。
curl --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/1/labels/documentation" \
  --data "new_name=docs&color=#8E44AD&description=Documentation"

レスポンス例:

{
  "id" : 8,
  "name" : "docs",
  "color" : "#8E44AD",
  "text_color" : "#FFFFFF",
  "description": "Documentation",
  "description_html": "Documentation",
  "open_issues_count": 1,
  "closed_issues_count": 0,
  "open_merge_requests_count": 2,
  "subscribed": false,
  "priority": null,
  "is_project_label": true,
  "archived": false
}

パラメータにnameまたはlabel_idを含む古いエンドポイントPUT /projects/:id/labelsはまだ利用可能ですが、非推奨です。

プロジェクトラベルをグループラベルにプロモート

プロジェクトラベルをグループラベルにプロモートラベルはIDを保持します。

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

レスポンス例:

{
  "id" : 8,
  "name" : "documentation",
  "color" : "#8E44AD",
  "description": "Documentation",
  "description_html": "Documentation",
  "open_issues_count": 1,
  "closed_issues_count": 0,
  "open_merge_requests_count": 2,
  "subscribed": false,
  "archived": false
}

パラメータにnameを含む古いエンドポイントPUT /projects/:id/labels/promoteはまだ利用可能ですが、非推奨です。

ラベルにサブスクライブ

認証済みユーザーが通知を受信できるように、ラベルをサブスクライブさせます。ユーザーがすでにラベルをサブスクライブしている場合、ステータスコード304が返されます。

POST /projects/: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/projects/5/labels/1/subscribe"

レスポンス例:

{
  "id" : 1,
  "name" : "bug",
  "color" : "#d9534f",
  "text_color" : "#FFFFFF",
  "description": "Bug reported by user",
  "description_html": "Bug reported by user",
  "open_issues_count": 1,
  "closed_issues_count": 0,
  "open_merge_requests_count": 1,
  "subscribed": true,
  "priority": null,
  "is_project_label": true,
  "archived": false
}

ラベルの登録解除

通知を受信しないようにするため、認証済みユーザーをラベルからサブスクライブ解除します。ユーザーがラベルをサブスクライブしていない場合、ステータスコード304が返されます。

POST /projects/: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/projects/5/labels/1/unsubscribe"