Ataccama ONE Agentic ONE Desktop ONE DQ&C ONE MDM ONE RDM ONE Runtime Server
Downloads

URN Reference

Resource identifiers in the Ataccama ONE Agentic Public API are Uniform Resource Names (URNs) following RFC 8141. URNs appear in request paths, request bodies, and responses.

URN structure

All URNs share the same structure:

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

  • urn:ata: Fixed prefix, consisting of the urn scheme and the ata (Ataccama) namespace.

  • {tenant}: Your tenant identifier, taken from the authentication context (lowercase letters, digits, and hyphens).

  • {realm}: The API area the resource belongs to, such as catalog or data-quality.

  • {resource-type}: The type of resource, such as catalog-item or dq-monitor.

  • {uuid}: The unique identifier of the resource, a UUID.

Example
urn:ata:acme-corp:data-quality:dq-monitor:123e4567-e89b-12d3-a456-426614174000

How to obtain URNs

URNs are returned by the API itself: list and create endpoints return the URNs of the resources they list or create. Save the URN from the response when you create a resource, and use it in subsequent requests.

Where a URN appears depends on the resource:

  • Resources created in the web application appear in list results like any other resource.

  • Sub-entities, such as rule input attributes or rule instances, have no list endpoints of their own: their URNs are returned inside the parent resource’s detail response.

  • DQ dimensions and their dimension results can be listed via GET /data-quality/v1/dq-dimensions (see List DQ dimensions).

  • DQ transformations can be listed via GET /data-quality/v1/dq-transformations (see List DQ transformations).

  • Groups, referenced as groupUrn in stewardship assignments (see Stewardship API), are managed in the web application and cannot be listed through the API.

    To build a groupUrn from the UUID shown in the web application, see Match rules and monitors between environments.

Special values

Some endpoints accept a literal keyword instead of a URN:

  • primary instead of a DQ monitor URN resolves to the primary DQ monitor of the catalog item.

  • latest instead of a processing workflow URN resolves to the most recently started processing run of the DQ monitor.

Endpoints that support these keywords state so in their documentation.

URN types by API

Catalog and Glossary

Resource URN format

Catalog item

urn:ata:{tenant}:catalog:catalog-item:{uuid}

Catalog item attribute

urn:ata:{tenant}:catalog:catalog-attribute:{uuid}

Location

urn:ata:{tenant}:catalog:location:{uuid}

Folder

urn:ata:{tenant}:catalog:folder:{uuid}

Source

urn:ata:{tenant}:catalog:source:{uuid}

Term

urn:ata:{tenant}:catalog:term:{uuid}

Detection rule

urn:ata:{tenant}:catalog:detection-rule:{uuid}

Documentation flow configuration

urn:ata:{tenant}:catalog:documentation-flow-configuration:{uuid}

Data Quality

Resource URN format

DQ monitor

urn:ata:{tenant}:data-quality:dq-monitor:{uuid}

DQ dashboard

urn:ata:{tenant}:data-quality:dq-dashboard:{uuid}

Processing (DQ monitor run)

urn:ata:{tenant}:processing:workflow:{uuid} (see Processing)

Rule

urn:ata:{tenant}:data-quality:rule:{uuid}

Rule instance

urn:ata:{tenant}:data-quality:rule-instance:{uuid}

Rule attribute

urn:ata:{tenant}:data-quality:rule-attribute:{uuid}

Rule parameter

urn:ata:{tenant}:data-quality:rule-parameter:{uuid}

Rule input group

urn:ata:{tenant}:data-quality:rule-input-group:{uuid}

Rule variable

urn:ata:{tenant}:data-quality:rule-variable:{uuid}

Dimension

urn:ata:{tenant}:data-quality:dq-dimension:{uuid}

Dimension result

urn:ata:{tenant}:data-quality:dq-dimension-result:{uuid}

Explanation

urn:ata:{tenant}:data-quality:explanation:{uuid}

DQ threshold

urn:ata:{tenant}:data-quality:dq-threshold:{uuid}

DQ alert finding

urn:ata:{tenant}:data-quality:dq-finding:{uuid}

DQ transformation

urn:ata:{tenant}:data-quality:dq-transformation:{uuid}

Data Observability

Resource URN format

Alert

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

Finding

urn:ata:{tenant}:data-observability:finding:{uuid}
Data observability findings (data-observability:finding) are a different resource type than DQ alert findings (data-quality:dq-finding). For data observability findings, see Monitor Data Observability Alerts via API.

Pipeline Monitoring

Resource URN format

Orchestrator

urn:ata:{tenant}:pipeline-monitoring:orchestrator:{uuid}

Pipeline job

urn:ata:{tenant}:pipeline-monitoring:pipeline-job:{uuid}

Dataset

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

Reference Data Management

Resource URN format

Table

urn:ata:{tenant}:reference-data:table:{uuid}

Draft dataset

urn:ata:{tenant}:reference-data:draft:{uuid}

Record

urn:ata:{tenant}:reference-data:record:{uuid}

Review dataset

urn:ata:{tenant}:reference-data:review:{uuid}

Published dataset

urn:ata:{tenant}:reference-data:published:{uuid}

Data Transformations

Resource URN format

Transformation plan

urn:ata:{tenant}:transformations:plan:{uuid}

Processing

Resource URN format

Processing workflow

urn:ata:{tenant}:processing:workflow:{uuid}

Processing job

urn:ata:{tenant}:processing:job:{uuid}

Other

Resource URN format

Group (IAM)

urn:ata:{tenant}:iam:group:{uuid}

Was this page useful?