ATataccama
Catalog Attributes

List catalog attributes

List the published catalog attributes, such as the columns of cataloged tables.

To list the attributes of a single catalog item, use the catalogItemUrn parameter.

The terms assigned to an attribute and its term detection denylist are part of every attribute returned. You don't need any query parameter to retrieve them.

Paging is forward-only.

get/catalog/v1/attributes

Request

Query parameters

afterstring

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

sizeinteger

Number of catalog attributes to return per page.

catalogItemUrnstring uri

A URN identifying a catalog item resource in the Catalog API.

Format: urn:ata:{tenant}:catalog:catalog-item:{uuid}

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

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

Filter attributes by parent catalog item URN, for example, urn:ata:acme-corp:catalog:catalog-item:fde84300-7a83-4d24-8c88-30ada80b0b54.

searchstring

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

namestring

Filter catalog item attributes by exact match on the 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[]

List of related resources to include in the response. When omitted, none of them are returned.

Supported values: effectiveCriticality. 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.

See Retrieve criticality in the Catalog API overview.

[
  "effectiveCriticality"
]

Response

Paginated list of published catalog attributes.

Example response

{
  "meta": {
    "next": "MjA=",
    "total": 150
  },
  "data": [
    {
      "catalogItemUrn": "urn:ata:acme-corp:catalog:catalog-item:7764f356-1b8c-43f4-8e15-651feacfca1c",
      "urn": "urn:ata:acme-corp:catalog:catalog-attribute:7764f356-1b8c-43f4-8e15-651feacfca1d",
      "name": "customername",
      "dataType": "STRING",
      "columnType": "varchar",
      "description": "This column contains the full names of customers",
      "termAssignments": [
        {
          "termUrn": "urn:ata:acme-corp:catalog:term:3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "source": "MANUAL"
        },
        {
          "termUrn": "urn:ata:acme-corp:catalog:term:1ede1262-f76b-4d00-9929-e92c15d8a5ba",
          "source": "TERM_DETECTION"
        }
      ],
      "termDetectionDenylist": [
        {
          "termUrn": "urn:ata:acme-corp:catalog:term:7c9e6679-7425-40de-944b-e07fc1f90ae7"
        }
      ],
      "effectiveCriticality": {
        "isCritical": true
      },
      "extraProperties": {
        "isPii": true,
        "sensitivity": "HIGH"
      }
    }
  ]
}

Changes

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