コンテンツにスキップ

レベル一覧



GET /api/v1/incidents/level/list

概要

現在のワークスペースのデフォルトレベルおよびカスタムレベルの設定を一覧表示します。

呼び出し前の確認と使用手順

Key は routine.defaultAccess または incidents.incidentsLevelManage のいずれかを満たす必要があり、現在の Key が所属するワークスペースのみが対象です。このモジュールは Issue レベル API と、基盤となるレベルおよびデフォルトレベルの設定を共有しています。変更はインシデント/Issue レベルの選択に同時に影響する可能性があります。本モジュールだけに独立したコピーを作成するものではありません。管理バックエンドでグローバルレベルを有効にした場合、実際に有効なレベルの選択はグローバル設定が優先的に決定する場合があります。本ワークスペースの管理リストには、引き続きデフォルト項目とワークスペースのカスタム項目のみが表示され、管理バックエンドのグローバルレベルは含まれません。管理者は有効範囲を確認したうえで変更し、管理リストのすべての項目を利用可能なレベルと見なさないでください。

リクエストパラメータはなく、ページネーションもありません。デフォルトの 4 項目は常に一覧表示され、ワークスペースのデフォルトスイッチは isDisabled で示されます。カスタム項目には isDefault=false と主体サマリーが付加されます。リストを読み取っても、無効化されたデフォルト項目はフィルタリングされません。インシデントレベルを選択する前に、スイッチ/管理バックエンドのグローバル優先ルールを確認する必要があり、管理リストに表示されていることを利用可能であることの証明としないでください。デフォルト項目にはデータベース id/creator などのカスタムエンティティフィールドがありません。クライアントは 2 種類の形式に対応する必要があります。

リクエストヘッダー

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

パラメータ補足

ワークスペースのデフォルトレベルとワークスペースのカスタムレベルのみを一覧表示し、管理バックエンドのグローバルレベルは含まれません。デフォルト項目は isDisabled=true とマークされていても、管理レスポンスには引き続き一覧表示されます。

リクエスト例

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

レスポンス

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

フィールド 型 説明
content array<object> デフォルトの 4 項目が先頭にあり、ワークスペースのカスタム項目は createAt の降順です。ページネーションはなく、管理バックエンドのグローバルレベルを含みません。
content[].uuid string デフォルトは system_level_0/1/2/3、カスタムは issl_ などです。
content[].name string デフォルト名 P0/P1/P2/不明は言語設定に従って返され、カスタムは保存値を使用します。
content[].color string 表示色。
content[].description string レベルの説明。
content[].isDefault boolean デフォルトは true、カスタムは false。
content[].isDisabled boolean または null デフォルト項目のみ返され、ワークスペースのデフォルトレベルのスイッチに由来します。無効化されていても管理リストには残ります。
content[].id integer または null データベース行 ID。業務上の特定には uuid を使用し、送信前のスナップショットでは null になることがあります。
content[].status integer データベース状態。0 は有効、3 は削除。インシデントの業務状態 incidentsStatus とは異なります。
content[].creator string 作成主体。API Key の場合は通常 wsak_リソースUUID です。
content[].updator string 最終更新主体。更新がない場合は空になることがあります。
content[].createAt integer Unix 秒の作成時刻。
content[].updateAt integer Unix 秒の最終更新時刻。
content[].deleteAt integer Unix 秒の削除時刻。未削除は -1。
content[].workspaceUUID string カスタム項目のみ。所属ワークスペース。
content[].extend JSON または null カスタム項目のみ保存される拡張。
content[].extend.自定义字段 JSON 作成側が保存した動的拡張のキーと値。
content[].isManage boolean 本ワークスペースのカスタムは通常 false。
content[].creatorInfo object カスタム項目のみに含まれる主体サマリー。見つからない場合は {}。
content[].creatorInfo.uuid string 主体 UUID。システム応答の主体は空またはシステム識別子の場合があります。
content[].creatorInfo.status integer 主体の状態。
content[].creatorInfo.wsAccountStatus integer ワークスペースメンバーの状態。Key の場合は Key の状態を取得し、インシデントの状態ではありません。
content[].creatorInfo.username string ログイン名/Key 名/システム名。
content[].creatorInfo.name string 表示名。システム AI の表示名はサイト設定を使用します。
content[].creatorInfo.iconUrl string アバター URL。システムのサマリーでは省略されることがあります。
content[].creatorInfo.email string 連絡先メールアドレス。Key のサマリーでは Key UUID の場合があり、配信可能なメールアドレスではありません。
content[].creatorInfo.mobile string 連絡先電話番号。空の場合があります。
content[].creatorInfo.countryCode string 国番号。システムのサマリーでは省略されることがあります。
content[].creatorInfo.acntWsNickname string ワークスペースのニックネーム。システムのサマリーでは省略されることがあります。
content[].updatorInfo object カスタム項目のみに含まれる主体サマリー。見つからない場合は {}。
content[].updatorInfo.uuid string 主体 UUID。システム応答の主体は空またはシステム識別子の場合があります。
content[].updatorInfo.status integer 主体の状態。
content[].updatorInfo.wsAccountStatus integer ワークスペースメンバーの状態。Key の場合は Key の状態を取得し、インシデントの状態ではありません。
content[].updatorInfo.username string ログイン名/Key 名/システム名。
content[].updatorInfo.name string 表示名。システム AI の表示名はサイト設定を使用します。
content[].updatorInfo.iconUrl string アバター URL。システムのサマリーでは省略されることがあります。
content[].updatorInfo.email string 連絡先メールアドレス。Key のサマリーでは Key UUID の場合があり、配信可能なメールアドレスではありません。
content[].updatorInfo.mobile string 連絡先電話番号。空の場合があります。
content[].updatorInfo.countryCode string 国番号。システムのサマリーでは省略されることがあります。
content[].updatorInfo.acntWsNickname string ワークスペースのニックネーム。システムのサマリーでは省略されることがあります。
content[].declaration object 空でない各項目の現在のワークスペース共通宣言。
{
  "code": 200,
  "content": [
    {
      "name": "P0",
      "color": "#E94444",
      "description": "デフォルトレベル設定。業務上の重要機能が利用できず、多数のユーザーに影響します。",
      "uuid": "system_level_0",
      "isDefault": true,
      "isDisabled": false,
      "declaration": {}
    },
    {
      "name": "P1",
      "color": "#FF7931",
      "description": "デフォルトレベル設定。業務上の重要機能が利用できませんが、影響するユーザーは限定的です(内部ユーザーのみへの影響など)。",
      "uuid": "system_level_1",
      "isDefault": true,
      "isDisabled": false,
      "declaration": {}
    },
    {
      "name": "P2",
      "color": "#FFB44A",
      "description": "デフォルトレベル設定。業務の周辺機能が利用できず、障害が継続するとユーザー体験に広く影響します。",
      "uuid": "system_level_2",
      "isDefault": true,
      "isDisabled": false,
      "declaration": {}
    },
    {
      "name": "不明",
      "color": "#C9C9C9",
      "description": "デフォルトレベル設定。業務への影響は不明です。",
      "uuid": "system_level_3",
      "isDefault": true,
      "isDisabled": false,
      "declaration": {}
    },
    {
      "id": 123,
      "uuid": "issl_example",
      "status": 0,
      "creator": "wsak_example",
      "updator": "",
      "createAt": 1785427200,
      "updateAt": -1,
      "deleteAt": -1,
      "workspaceUUID": "wksp_example",
      "name": "P3-軽微",
      "color": "#3F94DC",
      "description": "一部機能に影響あり",
      "extend": {},
      "isManage": false,
      "declaration": {},
      "isDefault": false,
      "creatorInfo": {},
      "updatorInfo": {}
    }
  ],
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

エラーレスポンス

認証、レート制限、共通リクエストエラーの詳細は共通エラー定義を参照してください。

HTTP ステータス errorCode 発生条件 メッセージまたはレスポンスの説明 対応方法
500 ft.InternalServerError データベース読み取り、履歴オブジェクト/設定形式、関連サマリーの構築などにおける未処理例外 内部エラー クエリパラメータを確認し、traceId を保持してください。バックオフして再試行できます。継続的に失敗する場合は、管理者に関連する履歴レコードとサービスログを確認してもらってください。

フィードバック

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