ATataccama
Terms

Update term

Update specific fields of a term using JSON Merge Patch (RFC 7396). You only need to specify the fields you want to change.

The response returns the updated term with all fields, the same structure as Get term.

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

patch/catalog/v1/terms/{urn}

Request

Path parameters

urnstring uri required

A URN identifying a term resource in the Catalog API.

Format: urn:ata:{tenant}:catalog:term:{uuid}

Example: urn:ata:acme-corp:catalog:term:123e4567-e89b-12d3-a456-426614174000.

Example:urn:ata:acme-corp:catalog:term:123e4567-e89b-12d3-a456-426614174000

URN identifier of the term.

Request body

namestring nullable

Updated name for the term.

descriptionstring nullable

Updated description for the term.

extraPropertiesExtraProperties

A map of properties associated with the entity defined in the metadata model. Only scalar and reference properties are supported, including arrays.

In responses, only properties explicitly requested via the extraProperties query parameter are included.

In PATCH requests, only the properties listed in the body are modified; set a property to null (for scalars) or [] (for reference arrays) to clear its value.

To find which extra properties are available for an entity, retrieve its entity definition through the Metadata model entities endpoints: catalogItem for catalog items, attribute for catalog attributes, source for sources, folder for folders, and the term's own type (for example, businessTerm) for terms.

Example request

{
  "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"
          }
        ]
      }
    ]
  },
  "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"
    ]
  }
}

Response

The updated term, with the same structure as Get term.

urnstring uri required

A URN identifying a term resource in the Catalog API.

Format: urn:ata:{tenant}:catalog:term:{uuid}

Example: urn:ata:acme-corp:catalog:term:123e4567-e89b-12d3-a456-426614174000.

extraPropertiesExtraProperties

A map of properties associated with the entity defined in the metadata model. Only scalar and reference properties are supported, including arrays.

In responses, only properties explicitly requested via the extraProperties query parameter are included.

In PATCH requests, only the properties listed in the body are modified; set a property to null (for scalars) or [] (for reference arrays) to clear its value.

To find which extra properties are available for an entity, retrieve its entity definition through the Metadata model entities endpoints: catalogItem for catalog items, attribute for catalog attributes, source for sources, folder for folders, and the term's own type (for example, businessTerm) for terms.

typestring required

The exact type of term as defined in the metadata model, for example, businessTerm or securityTerm.

namestring required

Name of the term.

descriptionstring

Description of the term.

Example response

{
  "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.