統合カタログエンティティの削除¶
POST /api/v1/unified_catalog/entity/delete
概要¶
エンティティをハード削除します。
呼び出し前と使用手順¶
認証されたワークスペースに従って、対象エンティティと関連エッジを削除します。関連エンティティは再帰的に削除されません。これはハード削除であり、ライフサイクル保護マークの制限を受けません。再送信により再度作成できます。実行前に URN と必要な属性をバックアップし、業務上の必要性を確認してください。このインターフェースをライフサイクルの無効化として扱わないでください。
監査のために旧エンティティを先に読み取り、その後、同期的にダウンストリームへ削除を要求します。単独の「実際に削除された行数」という戻り値は存在せず、成功時は true のみです。エラーが発生した場合はまず読み戻し、エラーだけに基づいて未削除と判断しないでください。単一削除を一括削除の結果構造として扱わないでください。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
リクエスト Body パラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| urn | string | Y | 読み取り/削除では必須で、前後の空白を除去した後に空でない必要があります。一覧/統計では任意の完全一致フィルターです。変更時は元の URN を明示的に入力し、名前変更時に別のエンティティが作成されないようにすることを推奨します。 null を許可: False 例: urn:database:default:demo取得または入力方法: このワークスペースのエンティティ一覧 items[].urn から取得し、完全な URN をそのまま使用することを優先します。 |
パラメータ補足説明¶
リクエストパラメータの説明
| パラメータ名 | type | 必須 | 説明 |
|---|---|---|---|
| urn | string | 必須 | 削除するエンティティの URN |
呼び出し時の注意事項
- 削除に成功すると
trueを返します。 - このインターフェースは Kodo 側の対応するエンティティも同期的に削除します。
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/unified_catalog/entity/delete' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"urn":"urn:database:default:demo"}'
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content | boolean | 削除呼び出しが成功した場合は true。エンティティ/削除件数は返しません。 |
{
"code": 200,
"content": true,
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、および共通リクエストエラーの詳細は共通エラー定義を参照してください。
ダウンストリームのエラーは Kodo の共有マッピングに従います。4xx では実際の HTTP ステータスと ft.KodoCommonApiErr、またはマッピング済みのビジネスコードを返す場合があります。すべての失敗が 406 に変換されるわけではありません。透過されない 5xx、接続異常、成功結果の構造不一致は最終的に 500 ft.InternalServerError になります。errorCode/message/traceId を保持し、読み取りまたは書き込みフェーズに応じて処理してください。HTTP の成功は、エンティティの実際の可視性の受け入れ確認に代わるものではありません。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 処理方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反している | パラメータ解析失敗 | パラメータの位置、フィールド名、型、値を確認してください。 |
| 400 | ft.RequestJsonFormatError | リクエスト JSON の構文が無効 | リクエスト JSON の形式エラー | content.reason、line、column に従って JSON を修正してください。 |
| 400 | ft.JsonFormatError | Body のトップレベルが JSON オブジェクトではない | 一部の json ファイルの形式エラー | 配列/文字列ではなく、例に従ってオブジェクトを送信してください。 |
| 406 | ft.InvalidParameter | urn が空;一括削除の urns が 1..500 個の、空でなく、空白除去後に重複しない文字列ではない | パラメータ {} が無効 |
現在のワークスペースの実際の URN 一覧を使用してください。まず重複を除去して対象を確認し、任意のオブジェクト/数値を送信しないでください。 |
| 500 | ft.InternalServerError | ダウンストリームの削除/旧エンティティの読み取り失敗、タイムアウト、または一括削除の返却件数/一覧の不一致 | 内部エラー | 削除がすでにコミットされている可能性があるため、まず対象の現在の状態を確認してください。同じ対象を引き続き削除する必要がある場合は、回数を限定して再試行し、traceId を保持してください。 |