REST API Overview

Catalog Items API: List, filter, retrieve, update, and delete catalog items, create SQL catalog items, and list, retrieve, and update catalog item attributes.

Query cataloged data assets programmatically.

Update catalog item metadata and descriptions.

Filter catalog items by name, source, assigned terms, or attributes.

Retrieve which catalog items and attributes are critical data elements.

Create SQL catalog items using an SQL query.

Integrate catalog data with external data governance tools.

Folders API: List, create, retrieve, update, and delete folders.

Prepare the folder structure before creating SQL catalog items through the API.

Recreate folders when migrating SQL catalog items from another environment.

Browse the folder hierarchy of a source.

Terms API: List, create, update, and delete terms with detection rules.

Import glossary terms from external systems.

Automate term creation and maintenance.

Manage detection rules for automated term assignment.

Synchronize business glossary across systems.

Term Assignments API: Assign and unassign terms on catalog item attributes in batch, and manage the terms that term detection must not assign.

Migrate manually assigned terms from another catalog or a previous Ataccama ONE deployment.

Keep assigned terms in sync with an external data governance tool.

Prevent term detection from reassigning terms that were deliberately removed.

Sources API: List, create, retrieve, update, and delete sources.

Recreate sources when importing metadata from external systems.

Automate source creation during platform migrations.

Update source metadata.

Stewardship API: Retrieve effective stewardship and assign, transfer, or clear stewardship, for single entities or in batch.

Transfer asset ownership between teams, for example, during a reorganization.

Assign stewardship in bulk after importing metadata from external systems.

Report on asset ownership in external data governance tools.

Generic Metadata Entities API: List, create, retrieve, update, and delete entities, individually or in batches.

Create and manage custom entity types defined in your metadata model.

Work with built-in entity types that don’t have a dedicated API yet.

Perform bulk metadata operations with batch create, update, and delete.

Metadata Model API: List entity types and retrieve their definitions, including properties and type hierarchy.

Discover the entity types available in your environment, including custom ones.

Look up the properties an entity type supports before creating or updating entities through the Generic Metadata Entities API.

Check whether an entity type or property is editable or read-only.

Set up DQ Rules and Monitors via API: Create and publish rules, configure a monitor, and run the first evaluation on a new data source.

Run DQ Evaluation from Pipelines: Run DQ evaluation from your pipeline, poll for completion, and decide whether to proceed based on the results.

Move DQ Rules and Monitors Between Environments: Migrate rules and monitors to another environment and propagate later changes.

Manage DQ Rules via API: List, create, update, publish, and delete DQ rules, including batches of up to 100.

Manage DQ Monitors via API: List, create, configure, publish, and delete DQ monitors.

Manage DQ Dashboards via API: List, create, retrieve, and publish DQ dashboards that aggregate the results of selected DQ monitors.

Retrieve DQ Results for External Systems: Retrieve DQ evaluation results, browse processing history, and access invalid samples.

URN Reference: Understand the URN identifiers the API works with.

Set up DQ rules and monitors for new data sources automatically.

Run DQ evaluations from data pipelines and use the results to stop downstream processing when quality thresholds are breached.

Retrieve quality results for reporting and dashboards.

Access invalid samples for data remediation.

Move DQ configuration between environments, for example from development to production.

Set up DQ dashboards that aggregate results across DQ monitors.

Monitor Data Observability Alerts via API: List, filter, and retrieve alerts and their findings.

Forward alerts and their findings to ticketing or incident management systems.

Drill down from an alert to its findings and identify the affected assets.

Build operational dashboards on alerts in your BI tool.

Retrieve alerts and findings for compliance or internal audits.

Pipeline Monitoring API: List and retrieve orchestrator connections, pipeline jobs, and datasets.

Get the details of the pipeline jobs and datasets that data observability findings reference.

Map observed datasets to catalog items.

Inventory connected orchestrators and observed pipeline jobs.

Transformation Plans API: Execute published transformation plans programmatically.

Integrate transformations into external orchestration tools (Airflow, Azure Data Factory).

Trigger event-driven data processing.

Automate batch data transformation workflows.

Coordinate multi-step data pipelines.

Reference Data API: Query tables, records, and apply filters.

Reference Data Lifecycle Management: Create, update, publish, and manage data through workflows.

Read published reference data for downstream systems.

Automate reference data updates from external sources.

Implement review and approval workflows.

Synchronize reference data across environments.

Processing API: Poll workflow state, list and cancel workflows, and inspect their jobs.

Poll a processing workflow started from another API, such as a DQ evaluation.

Cancel a running workflow.

Diagnose failed runs from their jobs and error reasons.