ATataccama
Generic Metadata Entities

Create entities in batch

Create up to 100 entities in a single request.

Each item has the same fields as Create entity, as well as the optional correlation id.

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

Request

Request body

Example request

{
  "data": [
    {
      "id": "item-1",
      "concreteType": "businessTerm",
      "parentProperty": "terms",
      "properties": {
        "name": "PII",
        "abbreviation": "PII"
      }
    },
    {
      "id": "item-2",
      "concreteType": "businessTerm",
      "parentProperty": "terms",
      "properties": {
        "name": "Sensitive Data"
      }
    }
  ]
}

Response

Multi-status batch outcome. Because creates 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.

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.