Datasets

List datasets

List the observed datasets.

To find the dataset matched to a catalog item, use the catalogItemUrn parameter. Each catalog item matches at most one dataset, so the response contains one dataset or none.

Paging is forward-only.

get/pipeline-monitoring/v1/datasets

Request

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

Query parameters

afterstring

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

sizeinteger

Number of datasets to return per page.

sortstring

Field to sort by; prefix with a hyphen (-) for descending order. Only createdAt is supported, and only one field per request. Default: -createdAt (newest first).

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

Restricts the result to the dataset matched to the given catalog item. The mapping is unique, so at most one dataset is returned.

Response

Paginated list of datasets.

Example response

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