Datasets

Get dataset

Retrieve a dataset by URN.

URL-encode the dataset URN when placing it in the request path. Each colon (:) becomes %3A.

get/pipeline-monitoring/v1/datasets/{datasetUrn}

Request

  • Base URL
    https://your-environment.ataccama.one/api
  • Auth
    HTTP bearer

Path parameters

datasetUrnstring uri required

URN of an observed dataset.

Format: urn:ata:{tenant}:pipeline-monitoring:dataset:{uuid}

Example: urn:ata:acme-corp:pipeline-monitoring:dataset:0197f3a0-7777-7c0c-8f9d-3a2b4c5d6e7f.

Example:urn:ata:acme-corp:pipeline-monitoring:dataset:0197f3a0-7777-7c0c-8f9d-3a2b4c5d6e7f

Dataset URN.

Response

The requested dataset.

urnstring uri required

URN of an observed dataset.

Format: urn:ata:{tenant}:pipeline-monitoring:dataset:{uuid}

Example: urn:ata:acme-corp:pipeline-monitoring:dataset:0197f3a0-7777-7c0c-8f9d-3a2b4c5d6e7f.

namestring required

The fully qualified dataset name as observed (the OpenLineage full name), for example, warehouse.public.customers. The combination of name and namespace is unique across all datasets.

namespacestring required

The OpenLineage namespace of the dataset, which identifies the data store it lives in, for example, postgres://warehouse:5432.

dataStoreNamestring required

The name of the data store the dataset belongs to.

catalogItemUrnsCatalogItemUrn[] required

The URNs of the catalog items matched to the dataset. The list is empty while the dataset is not matched to any catalog item. To get the details of a catalog item, use the Catalog API.

createdAtstring date-time required

When the dataset was first recorded.

Example response

{
  "urn": "urn:ata:acme-corp:pipeline-monitoring:dataset:0197f3a0-7777-7c0c-8f9d-3a2b4c5d6e7f",
  "catalogItemUrns": [
    "urn:ata:acme-corp:catalog:catalog-item:123e4567-e89b-12d3-a456-426614174000"
  ]
}

Changes

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