コンテンツにスキップ

デフォルト設定状態の変更



POST /api/v1/incidents/level/config/set

概要

現在のワークスペースのデフォルトインシデントレベルを有効化または無効化します。

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

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

isDisabled ブール値を必ず渡します。true でデフォルトの4レベルを無効化し、false で有効化します。デフォルト項目は削除されず、ワークスペースのカスタムレベルの保存にも影響せず、既存のインシデント/Issue/モニターの参照も変更されません。現在、「少なくとも1つの利用可能なカスタムレベルを維持する/デフォルトレベルの参照が残っている場合は無効化できない」という保護は有効になっていません。無効化する前に適切なレベルを作成して移行し、利用可能な選択肢を失わないようにしてください。同じ設定を繰り返すと設定が書き込まれ、有効化/無効化の監査が記録されます。副作用がないことは保証されません。

レスポンスは config_get と異なります。このページでは設定のデータベースエンティティを返し、対象値は content.config.isDisabled にあります。読み取りページでは content.isDisabled を返します。タイムアウト/失敗時は、まず config_get で対象値が保存済みか確認してから、再試行するか決定してください。

リクエストヘッダー

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

リクエスト Body パラメータ

パラメータ名 型 必須 説明
isDisabled bool Y 必須の boolean。true で無効化/false で有効化します。省略/null/文字列は不可です。デフォルトレベルは削除されず、参照も移行されません。
null を許可: False
例: true
取得または入力方法: ワークスペース管理者が、デフォルトの4レベルを引き続きレベル選択に含めるか確認します。

リクエスト例

curl --request POST 'https://openapi.guance.com/api/v1/incidents/level/config/set' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"isDisabled":true}'

レスポンス

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

フィールド 型 説明
content.id integer または null データベース行 ID。業務上の特定には uuid を使用し、送信前のスナップショットでは null になる場合があります。
content.uuid string このリソースの UUID。
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 現在のワークスペース UUID。
content.keyCode string 固定値 IssueLevelDisabled。Issue レベルと共有されます。
content.config object 保存されたスイッチオブジェクト。
content.config.isDisabled boolean 保存された対象値。true でデフォルトの4レベルを無効化し、false で有効化します。
content.declaration object 現在のワークスペースの共通宣言。
{
  "code": 200,
  "content": {
    "id": 123,
    "uuid": "ctcf_example",
    "status": 0,
    "creator": "wsak_example",
    "updator": "",
    "createAt": 1785427200,
    "updateAt": -1,
    "deleteAt": -1,
    "workspaceUUID": "wksp_example",
    "keyCode": "IssueLevelDisabled",
    "config": {
      "isDisabled": true
    },
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

エラーレスポンス

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

HTTP ステータス errorCode 発生条件 メッセージまたはレスポンスの説明 対処方法
406 ft.ParameterValidationFailed リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反しています パラメータ解析失敗 パラメータの位置、フィールド名、型、値を確認してください。
400 ft.RequestJsonFormatError リクエスト JSON の構文が無効です リクエスト JSON の形式エラー content.reason、line、column に従って JSON を修正してください。
400 ft.JsonFormatError JSON のトップレベルがオブジェクトではありません 一部の JSON ファイルの形式エラー isDisabled ブール値を含むオブジェクトを送信してください。
500 ft.InternalServerError データベース、設定/ID 形式、または未処理のシステム例外 内部エラー 読み取りはバックオフして再試行できます。書き込みは、まず設定/レベルリストを読み戻して保存済みか確認してから、再試行するか決定してください。

フィードバック

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