ATataccama
Terms

Get term

Retrieve a term by URN.

To return extra properties, list the property names you need in the extraProperties parameter. To return criticality or stewardship, use the include parameter.

get/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.

Query parameters

extraPropertiesstring[]

Comma-separated list of extra property names to include in the extraProperties field of the response. When omitted, no extra properties are returned.

The property names must exactly match the property names defined in the metadata model. Only scalars, references and their arrays are supported.

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, dataProduct for data products, dataProductStatus for data product statuses, domain for domains, and the term's own type (for example, businessTerm) for terms. Extra properties cannot be used as filter criteria.

[
  "isPii",
  "community",
  "domains"
]
includestring[]

Comma-separated list of related resources to include in the response. When omitted, none of them are returned.

Supported values: effectiveCriticality, effectiveStewardship. Any value outside the supported set is rejected with 400 VALIDATION_ERROR. Resolving included resources takes additional processing time. Request them only when you need them.

[
  "effectiveStewardship",
  "effectiveCriticality"
]

Response

A 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.