デフォルト設定状態の取得¶
GET /api/v1/issue-level/config/get
概要¶
現在のワークスペースにおける、システムデフォルトの Issue レベルの有効化スイッチを読み取ります。
呼び出し前の確認と使用手順¶
クエリパラメーターは不要です。content.isDisabled=false はシステムデフォルトのレベルが有効であることを示し、true は無効であることを示します。設定がまだ保存されていない場合は、デフォルトで false になります。このスイッチは最終的な有効レベルの集合を表すものではありません。プラットフォームのグローバルレベルが有効な場合はグローバルレベルが優先されるため、有効なレベル一覧を参照して選択可能な項目を確認してください。操作は現在の API Key が属するワークスペースを使用します。リソース識別子は同じワークスペースから取得してください。
リクエストヘッダー¶
| パラメーター名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作の権限を持つ OpenAPI Key を取得します。 |
パラメーターの補足説明¶
読み取り結果はスイッチオブジェクトそのものです。設定インターフェースが返す完全な設定レコードの構造とは異なります。
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/issue-level/config/get' \
-H 'DF-API-KEY: <DF-API-KEY>'
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要なフィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content.isDisabled | boolean | システムデフォルトのレベルが無効かどうか。デフォルトは false。 |
| content.declaration | object または null | ワークスペースの共通宣言。content のこの階層にのみ付加されます。 |
{
"code": 200,
"content": {
"isDisabled": false,
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、および共通リクエストエラーの詳細は、共通エラー定義を参照してください。
スイッチが未保存の場合でも、成功時は isDisabled=false を返し、設定が存在しないというエラーは報告されません。認証、バージョン、およびレート制限の失敗については、共通エラーの説明を参照してください。