Findings

Get finding

Retrieve a finding by URN.

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

get/data-observability/v1/findings/{findingUrn}

Request

Path parameters

findingUrnstring uri required

URN of a Data Observability finding.

Format: urn:ata:{tenant}:data-observability:finding:{uuid}

Example: urn:ata:acme-corp:data-observability:finding:0197f3a0-2222-7c0c-8f9d-3a2b4c5d6e7f.

Example:urn:ata:acme-corp:data-observability:finding:0197f3a0-2222-7c0c-8f9d-3a2b4c5d6e7f

The URN of the finding, URL-encoded.

Response

The requested finding.

urnstring uri required

URN of a Data Observability finding.

Format: urn:ata:{tenant}:data-observability:finding:{uuid}

Example: urn:ata:acme-corp:data-observability:finding:0197f3a0-2222-7c0c-8f9d-3a2b4c5d6e7f.

alertUrnstring uri

URN of a Data Observability alert.

Format: urn:ata:{tenant}:data-observability:alert:{uuid}

Example: urn:ata:acme-corp:data-observability:alert:0197f3a0-1111-7c0c-8f9d-3a2b4c5d6e7f.

findingTypestring required

The type of the finding as a hierarchical, dot-separated code, for example, data.dq.threshold-breach-rule or job.failure. In filters, a value matches the exact code and all its subtypes.

For the full taxonomy and the meaning of each code, see the Findings group description. The set is fixed within a release but can change between releases. Handle unknown codes gracefully.

severitystring required

@ExtensibleEnum The severity of the finding: LOW, MEDIUM, HIGH, or CRITICAL.

statusstring required

@ExtensibleEnum The finding lifecycle status:

  • ACTIVE: The problem is still being observed.
  • STALE: The problem has not been observed recently.
  • INACTIVE: The problem has ended (see endedAt).
summarystring

A human-readable summary of the finding, for example, Completeness on customer.email dropped to 71% (threshold 95%).

affectedAssetUrnstring uri required

A URN identifying a resource in any realm of the Public API. URNs follow RFC 8141.

Format: urn:ata:{tenant}:{realm}:{resource-type}:{uuid}

Components:

  • urn — fixed scheme
  • ata — Ataccama namespace
  • {tenant} — tenant identifier from the authentication context
  • {realm} — API realm, for example catalog or reference-data
  • {resource-type} — resource type within the realm, for example catalog-item or table
  • {uuid} — UUID (v4 or v7) of the resource

Example: urn:ata:acme-corp:reference-data:table:123e4567-e89b-12d3-a456-426614174000.

firstSeenAtstring date-time required

When the problem was first observed.

lastSeenAtstring date-time required

When the problem was last observed.

endedAtstring date-time nullable

When the problem ended. Set only once the finding is INACTIVE; omitted while it is ACTIVE or STALE. The type still admits null so a future implementation may send it explicitly.

createdAtstring date-time required

When the finding was registered (the server-side ingest time). This is the default sort field; it can differ from firstSeenAt by ingest lag.

Example response

{
  "urn": "urn:ata:acme-corp:data-observability:finding:0197f3a0-2222-7c0c-8f9d-3a2b4c5d6e7f",
  "alertUrn": "urn:ata:acme-corp:data-observability:alert:0197f3a0-1111-7c0c-8f9d-3a2b4c5d6e7f",
  "findingType": "job.failure",
  "severity": "LOW",
  "status": "ACTIVE",
  "affectedAssetUrn": "urn:ata:acme-corp:reference-data:table:123e4567-e89b-12d3-a456-426614174000"
}

Changes

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