ATataccama
Terms

List terms

List the published terms.

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

Paging is forward-only.

get/catalog/v1/terms

Request

Query parameters

afterstring

Cursor for forward pagination. Use the value from meta.next in the previous response.

sizeinteger

Number of terms to return per page.

searchstring

Full-text query matched against all string properties of the term, such as name and description.

namestring

Filters results by exact match on the term name.

sortstring[]

Comma-separated field names for sorting results, where fields prefixed with a hyphen (-) sort descending. Only name is supported.

Examples:

  • ?sort=name — sort by name ascending
  • ?sort=-name — sort by name descending
[
  "name"
]
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

Paginated list of terms.

Example response

{
  "meta": {
    "next": "MjA=",
    "total": 150
  },
  "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.