統合カタログのエンティティタイプ削除¶
POST /api/v1/unified_catalog/entity_type_cfg/delete
概要¶
現在のワークスペースにエンティティが存在しないカスタムタイプを削除します。
呼び出し前の確認と使用手順¶
削除できるのはカスタムタイプのみです。公式タイプは、現在のワークスペースでオーバーライドを設定できる場合でも削除できません。削除前に、そのタイプの現在のワークスペースにおけるエンティティ数を同期的に照会し、件数が 0 より大きい場合は拒否します。タイプの削除は論理削除の設定であり、この API でエンティティを一括削除するものではありません。また、他のワークスペースのタイプの削除や、過去のオーバーライド記録の自動クリーンアップを保証するものでもありません。事前に、後続の収集処理がそのタイプを引き続き送信しないことを確認してください。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
リクエストボディパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| entityTypeUUID | string | Y | 詳細と entityType の少なくとも一方が必要です。UUID が非空の場合は UUID を優先し、両者の一致は検証しません。default を指定すると、非表示の status=3 の作成テンプレートを返し、エンティティ件数は照会しません。削除時は実際のタイプ UUID が必須で、エンコードは使用しません。 null を許可: False 例: enty_example取得または入力方法: タイプリストの items[].uuid から enty_ 識別子を取得するか、default で作成テンプレートを取得します。 |
パラメータの補足説明¶
リクエストパラメータの説明
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| entityTypeUUID | string | はい | 対象エンティティタイプの UUID |
呼び出し時の注意事項
- 削除できるのはカスタムタイプのみです。デフォルトタイプは削除できません。
- 対象のエンティティタイプにエンティティが残っている場合、API は削除失敗を返します。
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/unified_catalog/entity_type_cfg/delete' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"entityTypeUUID":"enty_example"}'
レスポンス¶
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 ファイルの形式エラー | 例に従ってオブジェクトを送信し、配列/文字列は使用しないでください。 |
| 404 | ft.NotFoundCatalogEntityType | 対象タイプが存在しない/削除済み、または現在参照できません | 指定されたエンティティタイプが見つかりません | タイプリストから実際の対象 UUID を取得してください。 |
| 406 | ft.ForbiddenDeletePresetCatalogEntityType | 対象の sourceType=default | システムプリセットのエンティティタイプは削除できません | 公式タイプを保持し、必要に応じてワークスペースのオーバーライド設定を変更してください。 |
| 406 | ft.CatalogEntityTypeHasEntities | このタイプには現在のワークスペースに依然としてエンティティが存在します | 削除失敗。エンティティタイプにはまだ {} 個のエンティティがあります | まずエンティティリストを確認して業務上の承認に従って処理し、件数が 0 になってからタイプを削除してください。 |
| 500 | ft.InternalServerError | エンティティ件数のチェック、タイプの論理削除/データベースコミット、またはレスポンス処理に失敗しました | 内部エラー | まずタイプとエンティティの現在の状態を読み取り、削除済みかどうかを確認してから処理してください。この削除ではヘルス設定の世代/リセットタスクは実行されません。 |