削除¶
POST /api/v1/objc_cfg/delete
概要¶
指定したカスタムオブジェクト分類の下流データを削除します。
呼び出し前の準備と使用手順¶
このインターフェースでは、API Key に infrastructure.setManage 権限が必要です。
実際の呼び出しは POST /objc_cfg/delete で、Body の sourceType は custom_object 必須です。コントローラーはこのタイプに固定されており、システム object の削除はサポートされません。objc_name には実際の分類名を指定します。設定 UUID や表示エイリアスではありません。
この公開実装は、下流に対して該当する custom_object 分類データの削除を要求するのみで、ローカルの ObjcCfg をソフト削除する、メニューをクリーンアップする、またはサイトテンプレートを削除するロジックはありません。true を、カタログ表示設定も削除されたと解釈しないでください。また、実際の削除件数も返しません。データ削除は復元できないため、事前にバックアップと収集側の今後の報告動作を確認してください。報告が続くと分類が再び出現する可能性があります。
下流の削除が成功すると true を返します。タイムアウト/500 の場合はまず実際のデータを確認してください。削除が発生していないとは断定できません。盲目的に繰り返さないでください。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証資格情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| objc_name | string | Y | 削除 Body では必須です。パス出力/変更でも同じ分類名を使用し、名前は報告される class と一致させ、パスを URL エンコードします。エイリアスは表示のみを制御し、対象名としては使用しません。 null を許可: False 例: example_resources取得または入力方法: リソースカタログ一覧 の content[].name から分類コードを取得します。objc_ 設定 UUID や alias ではありません。 |
| sourceType | string | Y | 公開では必須で、object/custom_object のみです。共有内部関数の *_history はサポートしません。作成時は実際に templateInfo.main[0].class を取得するため、必ずこのフィールドと一致させます。変更/読み取りでは設定タイプの選択に使用します。削除の公開 API では custom_object のみで、コントローラーはこのタイプに固定されています。 null を許可: False 選択可能な値: ['custom_object'] 例: custom_object取得または入力方法: システムオブジェクトは object、カスタムリソースオブジェクトは custom_object を選択し、実際に報告されるデータソースを取得します。 |
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/objc_cfg/delete' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"sourceType":"custom_object","objc_name":"example_resources"}'
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content | boolean | 呼び出し処理が成功した場合 true。削除件数や項目ごとの結果ではありません。 |
{
"code": 200,
"content": true,
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。
変更/エクスポートできるのは、現在の API Key ワークスペースの設定のみです。一覧は認可された対象ワークスペースをカウントできますが、その表示設定は引き続き現在のワークスペースのものです。インターフェースには freeEdition バージョン宣言がありますが、共通 OpenAPI 認証はこのルートでそのバージョンチェックを実行しないため、バージョン自体を固定の 403 として記載しないでください。アップストリームの 4xx は実際の Kodo/権限マッピングに従って扱います。通常の 5xx は最終的に 500 ft.InternalServerError になります。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反 | パラメータ解析失敗 | パラメータの位置、フィールド名、型、値を確認します。 |
| 400 | ft.RequestJsonFormatError | リクエスト JSON の構文が無効 | リクエスト JSON 形式エラー | content.reason、line、column に従って JSON を修正します。 |
| 400 | ft.JsonFormatError | Body のトップレベルが JSON オブジェクトではない | 一部の json ファイル形式エラー | 本ページのフィールドを含むオブジェクトを送信します。 |
| 500 | ft.InternalServerError | 下流の削除失敗/タイムアウト、または応答処理で未捕捉の例外が発生 | 内部エラー | 分類名に基づいてデータの実際の状態を確認し、traceId を保持します。本インターフェースはローカル表示設定をクリーンアップしないため、一覧に項目が残っていることからデータ削除失敗と判断しないでください。 |