デフォルト設定状態の取得¶
GET /api/v1/incidents/level/config/get
概要¶
現在のワークスペースにおけるデフォルトのインシデントレベルの有効/無効スイッチを読み取ります。
呼び出し前の前提と使用手順¶
キーは routine.defaultAccess または incidents.incidentsLevelManage のいずれかに一致する必要があり、現在のキーが属するワークスペースのみを対象とします。このモジュールは Issue レベル API と、基盤となるレベルおよびデフォルトレベルの設定を共有しており、変更はインシデント/Issue レベルの選択に同時に影響する可能性があります。本モジュール内にのみ独立したコピーを作成するものではありません。バックエンドでグローバルレベルが有効になっている場合、実際に有効なレベルの選択はグローバル設定によって優先的に決定される場合があります。本ワークスペースの管理リストには引き続きデフォルト項目とワークスペースのカスタム項目のみが表示され、バックエンドのグローバルレベルは含まれません。管理者は有効となる基準を確認したうえで変更し、管理リストのすべての項目を利用可能なレベルとして扱わないでください。
設定値オブジェクトを返します。設定データベースのエンティティではありません。設定レコードがない場合、isDisabled=false、つまりデフォルトの 4 レベルが有効です。カスタムレベルのリストやバックエンドのグローバルスイッチは含まれません。インシデントレベル一覧を読み取ることで、デフォルト項目とカスタム項目を同時に確認できますが、実際に有効となるルールを引き続き判断する必要があります。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/incidents/level/config/get' \
-H 'DF-API-KEY: <DF-API-KEY>'
レスポンス¶
HTTP 200、application/json。以下の例は直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content.isDisabled | boolean | 現在のワークスペースのデフォルト 4 レベルスイッチ。false は有効、true は無効。設定がない場合は false。 |
| content.declaration | object | 現在のワークスペースの共通宣言。 |
{
"code": 200,
"content": {
"isDisabled": false,
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラー応答¶
認証、レート制限、および共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたは応答説明 | 対処方法 |
|---|---|---|---|---|
| 500 | ft.InternalServerError | データベース読み取り、履歴オブジェクト/設定形式、または関連サマリーの構築などにおける未処理例外 | 内部エラー | クエリパラメータを確認し、traceId を保持してください。バックオフして再試行できます。継続的に失敗する場合は、管理者に関連する履歴レコードとサービスログを確認してもらってください。 |