ATataccama
Terms

Create terms in batch

Create multiple terms in a single API call and publish them.

This is useful for importing glossary terms from external systems or populating the catalog with predefined terms.

The server generates URNs for the created terms automatically.

At least one term is required, and at most 100 terms can be created per request.

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.

Stewardship cannot be changed through this endpoint. To change the group responsible for the entity, use POST /catalog/v1/stewardship/manage.

post/catalog/v1/terms/batch/create

Request

Request body

Example request

{
  "data": [
    {
      "id": "item-1",
      "type": "businessTerm",
      "name": "PII",
      "description": "Personally Identifiable Information",
      "detectionRules": {
        "operator": "OR",
        "ruleAssignments": [
          {
            "detectionRuleUrn": "urn:ata:acme-corp:catalog:detection-rule:576d90b8-4c9f-483b-a309-9f7b6b367f80",
            "threshold": 80
          },
          {
            "detectionRuleUrn": "urn:ata:acme-corp:catalog:detection-rule:63c58461-1a6c-4d0c-9176-572c9b122d79"
          }
        ]
      },
      "extraProperties": {
        "isPii": true,
        "community": "Customer Solutions",
        "domains": [
          "urn:ata:acme-corp:catalog:domain:10bae762-0000-8010-8000-000001eb0065"
        ]
      }
    },
    {
      "id": "item-2",
      "type": "securityTerm",
      "name": "Sensitive Data",
      "detectionRules": {
        "operator": "AND",
        "ruleAssignments": [
          {
            "detectionRuleUrn": "urn:ata:acme-corp:catalog:detection-rule:576d90b8-4c9f-483b-a309-9f7b6b367f80"
          }
        ]
      },
      "extraProperties": {
        "isPii": false
      }
    }
  ]
}

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:123e4567-e89b-12d3-a456-426614174000",
        "effectiveStewardship": {
          "groupUrn": "urn:ata:acme-corp:iam:group:123e4567-e89b-12d3-a456-426614174000",
          "originUrn": "urn:ata:acme-corp:reference-data:table:123e4567-e89b-12d3-a456-426614174000"
        },
        "extraProperties": {
          "isPii": true,
          "community": "Customer Solutions",
          "status": "urn:ata:acme-corp:catalog:completeness-status:10bae762-0000-8010-8000-000001eb0070",
          "domains": [
            "urn:ata:acme-corp:catalog:domain:10bae762-0000-8010-8000-000001eb0065",
            "urn:ata:acme-corp:catalog:domain:10bae762-0000-8010-8000-000001eb0066"
          ]
        },
        "type": "businessTerm",
        "detectionRules": {
          "operator": "AND",
          "ruleAssignments": [
            {
              "detectionRuleUrn": "urn:ata:acme-corp:catalog:detection-rule:123e4567-e89b-12d3-a456-426614174000"
            }
          ]
        },
        "attributeToCatalogItemTermRules": {
          "operator": "AND",
          "rules": [
            {
              "operator": "AND",
              "terms": [
                {
                  "termUrn": "urn:ata:acme-corp:catalog:term:123e4567-e89b-12d3-a456-426614174000"
                }
              ]
            }
          ]
        }
      }
    }
  ]
}

Changes

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