ATataccama
Catalog Items

List catalog items

List the published catalog items.

Paging is forward-only.

get/catalog/v1/catalog-items

Request

Query parameters

afterstring

Cursor for forward pagination. Use the value from meta.next in the previous response. Starts at the beginning when omitted.

sizeinteger

Number of catalog items to return.

parentUrnstring

Filter catalog items by their direct parent: a folder URN for catalog items placed in folders, such as SQL catalog items, or a location URN for catalog items imported from a source.

Pass null to return only catalog items that aren't placed in any location or folder, such as transformation catalog items. When omitted, catalog items are not filtered by parent.

To find or create folders, use the Folders endpoints.

searchstring

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

namestring

Filter catalog items by exact match on the name.

sortstring[]

Comma-separated field names for sorting results; prefix with a hyphen (-) for descending order. 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.

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

[
  "effectiveStewardship",
  "effectiveCriticality"
]

Response

Paginated list of published catalog items.

Example response

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