ラベル API

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

GitLab 12.7 でレスポンス JSON にdescription_html - が追加されました。

ラベルの一覧

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

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

GET /projects/:id/labels

属性	種類	必須	説明
`id`	整数/文字列	yes	認証ユーザーが所有するプロジェクトのIDまたはURLエンコードされたパス
`with_counts`	boolean	いいえ	イシューやマージリクエストの数を含めるかどうか。デフォルトは`false`。(GitLab 12.2 で導入)
`include_ancestor_groups`	boolean	いいえ	祖先グループを含めます。デフォルトは`true`です。
`search`	文字列です。	いいえ	ラベルをフィルタリングするキーワード。GitLab 13.6 で導入。

curl --header "PRIVATE-TOKEN: <your_access_token>" "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
  },
  {
    "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
  },
  {
    "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
  },
  {
    "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
  },
  {
    "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
  }
]

プロジェクトラベルの取得

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

GET /projects/:id/labels/:label_id

属性	種類	必須	説明
`id`	整数または文字列。	yes	認証ユーザーが所有するプロジェクトのIDまたはURLエンコードされたパス
`label_id`	整数または文字列。	yes	プロジェクトのラベルのIDまたはタイトル。
`include_ancestor_groups`	boolean	いいえ	祖先グループを含めます。デフォルトは`true`です。

curl --header "PRIVATE-TOKEN: <your_access_token>" "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
}

新しいラベルの作成

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

POST /projects/:id/labels

属性	種類	必須	説明
`id`	整数/文字列	yes	認証ユーザーが所有するプロジェクトのIDまたはURLエンコードされたパス
`name`	文字列です。	yes	ラベルの名前
`color`	文字列です。	yes	ラベルの色を、先頭の’#’記号付きの6桁の16進数表記（例えば#FFAABB）またはCSSカラー名のいずれかで指定します。
`description`	文字列です。	いいえ	ラベルの説明
`priority`	整数。	いいえ	ラベルの優先度。0以上でなければなりません。優先順位を削除するには`null` 。

curl --data "name=feature&color=#5843AD" --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/labels"

応答例

{
  "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
}

ラベルの削除

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

DELETE /projects/:id/labels/:label_id

属性	種類	必須	説明
`id`	整数または文字列。	yes	認証ユーザーが所有するプロジェクトのIDまたはURLエンコードされたパス
`label_id`	整数または文字列。	yes	グループのラベルのIDまたはタイトル。

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

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

既存のラベルの編集

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

PUT /projects/:id/labels/:label_id

属性	種類	必須	説明
`id`	整数または文字列。	yes	認証ユーザーが所有するプロジェクトのIDまたはURLエンコードされたパス
`label_id`	整数または文字列。	yes	グループのラベルのIDまたはタイトル。
`new_name`	文字列です。	`color` が提供されない場合は yes	ラベルの新しい名前
`color`	文字列です。	`new_name` が提供されない場合は yes	ラベルの色を、先頭の’#’記号付きの6桁の16進数表記（例えば#FFAABB）またはCSSカラー名のいずれかで指定します。
`description`	文字列です。	いいえ	ラベルの新しい説明
`priority`	整数。	いいえ	ラベルの新しい優先度。優先順位を削除するには、ゼロまたは`null` より大きいか等しくなければなりません。

curl --request PUT --data "new_name=docs&color=#8E44AD&description=Documentation" \
     --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/labels/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
}

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

プロジェクトラベルをグループラベルに昇格させます。

GitLab 12.3 で導入されました。
GitLab 13.6以降では、プロジェクトラベルを昇格させることで、そのラベルのIDを保持したままグループラベルに変更することができます。以前は、プロジェクトラベルを昇格させると新しいIDで新しいグループラベルが作成され、古いラベルは削除されていました。

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

PUT /projects/:id/labels/:label_id/promote

属性	種類	必須	説明
`id`	整数または文字列。	yes	認証ユーザーが所有するプロジェクトのIDまたはURLエンコードされたパス
`label_id`	整数または文字列。	yes	グループのラベルのIDまたはタイトル。

curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "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
}

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

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

POST /projects/:id/labels/:label_id/subscribe

属性	種類	必須	説明
`id`	整数または文字列。	yes	認証ユーザーが所有するプロジェクトのIDまたはURLエンコードされたパス
`label_id`	整数または文字列。	yes	プロジェクトのラベルのIDまたはタイトル

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "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
}

ラベルの登録解除

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

POST /projects/:id/labels/:label_id/unsubscribe

属性	種類	必須	説明
`id`	整数または文字列。	yes	認証ユーザーが所有するプロジェクトのIDまたはURLエンコードされたパス
`label_id`	整数または文字列。	yes	プロジェクトのラベルのIDまたはタイトル

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

ラベル API

ラベルの一覧

プロジェクトラベルの取得

新しいラベルの作成

ラベルの削除

既存のラベルの編集

プロジェクトラベルをグループラベルに昇格させます。

ラベルの登録解除

Help & feedback

Docs

Product

Feature availability and product trials

Get Help

ラベル API

ラベルの一覧

プロジェクトラベルの取得

新しいラベルの作成

ラベルの削除

既存のラベルの編集

プロジェクトラベルをグループラベルに昇格させます。

ラベルの購読

ラベルの登録解除

Help & feedback

Docs

Product

Feature availability and product trials

Get Help