コンテンツにスキップ

レベル一覧



GET /api/v1/issue-level/list

概要

現在のワークスペースで実際に Issue に使用できる有効なレベルの集合を取得します。

呼び出し前と使用手順

最初にこの API を呼び出し、返された項目の uuid を Issue の作成または変更時の level に使用します。固定の P0/P1 などの表示名には依存しません。プラットフォームでグローバルレベルが有効になっている場合は、グローバル管理レベルを返します。それ以外の場合は、現在有効なシステムデフォルトレベルと、このワークスペースのカスタムレベルを返します。システムデフォルトレベルが無効化されている場合、この有効な一覧には含まれません。この API は content 配列を直接返し、ページネーションは行いません。順序は重大度の並び順を表すものではありません。有効な設定がない場合は、空の配列になることがあります。操作は、現在の API Key が属するワークスペースで実行されます。リソース識別子は同じワークスペースから取得してください。

リクエストヘッダー

パラメータ名 型 必須 説明
DF-API-KEY string Y ワークスペースの OpenAPI 認証情報。
例: <DF-API-KEY>
取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。

パラメータの補足説明

この API は実際に有効なレベルを返すものであり、完全なカスタムレベル管理リストではありません。グローバルレベルで上書きされたこのワークスペースのカスタムレベルは、必ずしも表示されません。デフォルトレベルの名前と説明は、ワークスペースの言語によって変わる場合があります。

リクエスト例

curl --get 'https://openapi.guance.com/api/v1/issue-level/list' \
  -H 'DF-API-KEY: <DF-API-KEY>'

レスポンス

HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示します。

フィールド 型 説明
content array<object> 有効なレベルの配列。項目はソースに応じて異なる任意フィールドを提供します。
content[].uuid string レベルの UUID。Issue.level に引き続き使用できるかどうかは、現在の有効なレベル一覧を基準にしてください。
content[].name string レベル名。ワークスペースの言語またはレベル設定に応じて表示されます。
content[].color string 色文字列。通常は #RRGGBB です。
content[].description string レベルの説明。
content[].isDefault boolean システムデフォルトレベルの項目では true を提供し、その他の項目では省略される場合があります。
content[].isManage boolean プラットフォームのグローバルレベルを採用する場合に true を提供し、ワークスペースのカスタムレベルでは省略される場合があります。
content[].status integer データベースのレベル項目が提供するレコード状態。通常は 0 です。
content[].declaration object または null 空でない各レベルオブジェクトに付加されるワークスペースの共通宣言。
{
  "code": 200,
  "content": [
    {
      "uuid": "system_level_1",
      "name": "P1",
      "description": "业务重要功能不可用,但影响用户有限。",
      "color": "#FF7931",
      "isDefault": true,
      "declaration": {}
    }
  ],
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

エラーレスポンス

認証、レート制限、および共通リクエストエラーについては、共通エラー定義を参照してください。

有効なレベルがない場合、成功時は空の配列を返します。追加のビジネスパラメータはありません。認証、バージョン、レート制限の失敗時は共通エラーの説明を使用します。

フィードバック

このページは役に立ちましたか?