ATataccama
Catalog Items

Get catalog item

Retrieve a catalog item by URN.

Catalog item attributes are not included in the catalog item response. To retrieve the attributes of a catalog item, use List catalog attributes with the catalogItemUrn query parameter.

The response doesn't include the SQL query of SQL catalog items either. To retrieve the query, use the Generic metadata entities endpoints to list the dslQuery entity of the catalog item: GET /catalog/v1/entities?entityType=dslQuery&parentUrn={catalogItemUrn}&properties=query.

To change the query, use Update catalog item.

get/catalog/v1/catalog-items/{urn}

Request

Path parameters

urnstring uri required

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

URN identifier of the catalog item.

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.

See Retrieve criticality in the Catalog API overview and Retrieve effective stewardship in the Stewardship tag.

[
  "effectiveStewardship",
  "effectiveCriticality"
]

Response

The catalog item.

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

namestring required

Name of the catalog item.

descriptionstring

Description of the catalog item.

originPathstring

Origin path of the catalog item in the source system.

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 response

{
  "urn": "urn:ata:acme-corp:catalog:catalog-item:fde84300-7a83-4d24-8c88-30ada80b0b54",
  "name": "customers",
  "description": "This table contains information about our customers",
  "originPath": "public/customers",
  "connection": {
    "urn": "urn:ata:acme-corp:processing:connection:b812d964-f94e-4be7-85c3-0073742ade09"
  },
  "termAssignments": [
    {
      "termUrn": "urn:ata:acme-corp:catalog:term:1ede1262-f76b-4d00-9929-e92c15d8a5ba"
    },
    {
      "termUrn": "urn:ata:acme-corp:catalog:term:3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ],
  "locations": [
    {
      "urn": "urn:ata:acme-corp:catalog:location:2b9d1f0a-3c4e-4a5b-9c8d-7e6f5a4b3c2d",
      "name": "public"
    },
    {
      "urn": "urn:ata:acme-corp:catalog:location:3c0e2a1b-4d5f-4b6c-8d9e-1f2a3b4c5d6e",
      "name": "CustomerDB"
    }
  ],
  "source": {
    "urn": "urn:ata:acme-corp:catalog:source:28e3ca71-635b-43c4-9d1b-bc9cc642721f"
  },
  "effectiveStewardship": {
    "groupUrn": "urn:ata:acme-corp:iam:group:b3c4d5e6-f7a8-4b9c-8d0e-1f2a3b4c5d6e",
    "originUrn": "urn:ata:acme-corp:catalog:source:28e3ca71-635b-43c4-9d1b-bc9cc642721f"
  },
  "effectiveCriticality": {
    "isCritical": true
  },
  "primaryDqMonitor": {
    "urn": "urn:ata:acme-corp:data-quality:dq-monitor:3c9e6679-7425-40de-944b-e07fc1f90ae7"
  },
  "aliases": [
    {
      "type": "COLLIBRA_ASSET_ID",
      "value": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "extraProperties": {
    "isPii": true,
    "community": "Customer Solutions",
    "domains": [
      "urn:ata:acme-corp:catalog:domain:10bae762-0000-8010-8000-000001eb0065"
    ]
  }
}

Changes

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