Batch Delete Entities in Unified Catalog¶

POST /api/v1/unified_catalog/entity/batch_delete

Overview¶

Batch delete unified catalog entities in the current workspace by a list of URNs.

Body Request Parameters¶

Additional Parameter Notes¶

• urns is required. Each request supports 1–500 items, in the format urn:<type>:<namespace>:<name> or <type>:<name>.
• After trimming leading/trailing whitespace, URNs must not be empty or duplicated. Deletion is performed only after all parameters pass validation.
• The workspace is determined by the DF-API-KEY authentication; it cannot be overridden in the request body.
• All inbound edges, outbound edges, and self-references of the target entities are cleaned up. Associated entities are not recursively deleted.
• success returns the normalized URNs in request order. successCount includes entities that did not exist before, representing the number of processed entries rather than the number of actually deleted rows.
• Hard deletion is not limited by lifecycle protection markers. Subsequent reporting can recreate the entities.
• A primary storage failure returns a global error with no partial-success list. A secondary storage (dual-write) failure does not change the successful result of the primary storage, and cross-engine transactions are not provided.
• A timeout may occur after the request has been committed. Callers can retry after confirming that the same targets still need to be deleted; Studio does not retry automatically.
• This API depends on Kodo to provide /v1/unified_catalog/entities/batch_delete.

Request Example¶

curl 'https://openapi.truewatch.com/api/v1/unified_catalog/entity/batch_delete' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"urns":["urn:service:default:api"]}'

Response¶

{
    "code": 200,
    "content": {
        "success": [
            "urn:service:default:api"
        ],
        "successCount": 1
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
}