ATataccama
Generic Metadata Entities

Update entities in batch

Update up to 100 entities in a single request.

Each item must include the entity urn; properties lists the properties to merge, following the same JSON Merge Patch (RFC 7396) semantics as Update entity. An item without properties succeeds without changing its entity.

The request is atomic: either every item succeeds or every item fails. The response never mixes success and failure outcomes. The meta summary therefore always has either success == total (and fail == 0) or fail == total (and success == 0).

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/patch

Request

Request body

Example request

{
  "data": [
    {
      "id": "item-1",
      "urn": "urn:ata:acme-corp:catalog:term:5d2c8a9e-1f47-4b36-8e0a-9c3b7d6f2a41",
      "properties": {
        "abbreviation": "SUPP"
      }
    },
    {
      "urn": "urn:ata:acme-corp:catalog:term:3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "properties": {
        "domains": [
          "urn:ata:acme-corp:catalog:domain:10bae762-0000-8010-8000-000001eb0065"
        ]
      }
    }
  ]
}

Response

Multi-status batch outcome. Because patches are atomic, every item in results reports the same outcome — all OK (with data) on success, or all non-OK (with error) on failure. meta.success therefore equals meta.total on success and 0 on failure.

Each result contains the properties changed by any item in the request, not only by its own item. In the example, the first item changes abbreviation and the second changes domains, so both results contain abbreviation and domains.

Example response

{
  "meta": {
    "total": 2,
    "success": 2
  },
  "results": [
    {
      "status": "OK",
      "data": {
        "urn": "urn:ata:acme-corp:catalog:term:5d2c8a9e-1f47-4b36-8e0a-9c3b7d6f2a41",
        "rootSuperType": "term",
        "concreteType": "businessTerm",
        "properties": {
          "name": "Supplier",
          "abbreviation": "SUP",
          "securityClassification": null
        }
      }
    }
  ]
}

Changes

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