ATataccama
Generic Metadata Entities

Delete entities in batch

Delete up to 100 entities in a single request.

Each item identifies the entity to delete by its urn.

Each item is processed independently: a failure on one item doesn't stop the rest.

Items that existed and were deleted are reported with status: OK and data.deleted: true. Items where no entity with the given URN was found are reported with status: RESOURCE_NOT_FOUND. Inspect meta for the success and fail totals.

Results are returned in the same order as the request items. Each item can carry an optional id, a caller-supplied correlation identifier echoed back in the corresponding result item.

post/catalog/v1/entities/batch/delete

Request

Request body

Example request

{
  "data": [
    {
      "id": "item-1",
      "urn": "urn:ata:acme-corp:catalog:term:123e4567-e89b-12d3-a456-426614174000"
    },
    {
      "id": "item-2",
      "urn": "urn:ata:acme-corp:catalog:term:3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ]
}

Response

Multi-status batch outcome. Each item in results reports its own outcome: OK (with data.deleted: true) when the entity existed and was deleted, or a non-OK status (with error) otherwise (for example, RESOURCE_NOT_FOUND for a missing entity). Inspect meta to see the totals.

Example response

{
  "meta": {
    "total": 2,
    "success": 2
  },
  "results": [
    {
      "status": "OK",
      "data": {
        "deleted": true
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.