デフォルト設定の状態変更¶
POST /api/v1/issue-level/config/set
概要¶
現在のワークスペースのシステムデフォルト Issue レベルを有効または無効にします。
呼び出し前の確認と使用手順¶
isDisabled=true で無効、false で有効になります。成功すると設定レコードを返します。実際のスイッチは content.config.isDisabled を読み取ります。設定取得 API を再度呼び出す場合、スイッチは content.isDisabled にあります。この設定は過去の Issue を自動変更せず、カスタムレベルも削除しません。現在のバージョンでは、少なくとも 1 つのカスタムレベルを保持することを強制検証しません。無効化する前に、有効なレベルのリスト と業務での利用状況を確認してください。プラットフォームのグローバルレベルが優先される場合、このワークスペースのスイッチはグローバル選択を上書きしません。操作には現在の API Key が属するワークスペースを使用します。同じワークスペースからリソース識別子を取得してください。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証資格情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
リクエストボディパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| isDisabled | bool | Y | 必須の boolean。true で無効、false で有効。 null を許可: False 例: true取得または入力方法: システムデフォルトレベルを引き続き提供する必要があるかどうかに応じて選択します。無効化する場合は true、復元する場合は false を使用します。 |
パラメータ補足説明¶
設定では有効化または無効化の監査が記録され、Issue の追加/変更通知は直接送信されません。
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/issue-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 | レコード番号。Issue の作成/返信のレスポンスでは、永続化前に構築される場合に null になることがあります。リソースを操作する際は uuid を使用してください。 |
| content.uuid | string | リソース UUID。 |
| content.workspaceUUID | string | 所属ワークスペース UUID。 |
| content.status | integer | レコードステータス。0 は正常、3 は削除済み。Issue の業務ステータス statusType とは区別します。 |
| content.creator | string | 作成呼び出し元の識別子。API Key 識別子、アカウント、またはシステム ID の場合があります。 |
| content.updator | string | 最終更新者。未設定の場合は空文字列です。 |
| content.createAt | integer | 作成日時(Unix 秒)。 |
| content.updateAt | integer | 最終更新日時(Unix 秒)。未更新の場合は -1 になることがあります。 |
| content.deleteAt | integer | 削除日時(Unix 秒)。未削除の場合は -1。 |
| content.keyCode | string | 設定レコードのタイプ識別子。 |
| content.config | object | スイッチ設定。 |
| content.config.isDisabled | boolean | 保存後のシステムデフォルトレベルの無効化スイッチ。 |
| content.declaration | object または null | ワークスペースの共通宣言。content のこの階層にのみ付加されます。 |
{
"code": 200,
"content": {
"id": 401,
"uuid": "ctcf_example",
"workspaceUUID": "wksp_example",
"status": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785430800,
"updateAt": -1,
"deleteAt": -1,
"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 ファイル形式エラー | JSON オブジェクトを送信してください。 |
| 500 | ft.InternalServerError | レベルまたは設定の保存、監査、その他の内部処理に失敗 | 内部エラー | まず現在のレベルまたは設定を読み取って結果を確認してから、再試行するか判断してください。継続的に失敗する場合は traceId を提供してください。 |