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

プロジェクトラベルAPI

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

このAPIを使用して、プロジェクトラベルを管理します。

グループラベルの場合は、グループラベルAPIを使用します。

すべてのプロジェクトラベルをリスト表示

指定されたプロジェクトのすべてのラベルをリスト表示します。

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

GET /projects/:id/labels
属性型必須説明
id整数または文字列はいプロジェクトのIDまたはURLエンコードされたパス
with_countsブール値いいえイシューとマージリクエストの数をインクルードするかどうか。falseがデフォルトです。
include_ancestor_groupsブール値いいえ祖先グループを含めます。trueがデフォルトです。
search文字列いいえラベルをフィルタリングするためのキーワード。
archivedブール値いいえtrueの場合、アーカイブされたラベルのみを返します。設定されていない場合、すべてのラベルを返します。
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整数いいえラベルの優先度。0以上であるか、nullを設定して優先度を削除する必要があります。
archivedブール値いいえtrueの場合、ラベルをアーカイブ済みとしてマークします。デフォルト値: false。
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が指定されていない場合はyesラベルの新しい名前
color文字列new_nameが指定されていない場合はyes先頭に「#」記号が付いた6桁の16進表記（例: #FFAABB）で指定されたラベルの色、またはCSSの色名のいずれか。
description文字列いいえラベルの新しい説明
priority整数いいえラベルの新しい優先度。0以上であるか、nullを設定して優先度を削除する必要があります。
archivedブール値いいえtrueの場合、ラベルをアーカイブ済みとしてマークします。デフォルト値: false。
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"