API Overview

The Ataccama ONE API provides programmatic access to platform capabilities, enabling you to integrate Ataccama ONE with your applications, automate workflows, and build custom solutions.

For the full API reference, see the API reference. This documentation covers what surrounds the endpoints: setting up access, the identifiers the API works with, and end-to-end workflows that combine several requests.

API resources

The following resources help guide you through using the Ataccama ONE API:

API reference: Learn about the request parameters, response fields, error codes, schemas, and examples, and download the OpenAPI specification.
API clients and access tokens: Create an API client in the Ataccama Cloud Portal and obtain tokens for the APIs.
Resource identifiers: Find out more about URN formats and how to obtain them.
Walkthroughs: Follow end-to-end workflows to make the most out of the Ataccama ONE API.

What you can do with the API

The API provides comprehensive access to Ataccama ONE capabilities:

Catalog management: Access and manage catalog items, attributes, assigned terms, folders, sources, and business terms.
Stewardship management: Read and change which group is responsible for your data assets.
Generic metadata management: Create, read, update, and delete entities of any type defined in the metadata model.
Metadata model introspection: Discover the entity types defined in the metadata model and the properties each type supports.
Transformation execution: Trigger transformation plans and integrate data processing into your workflows.
Reference data lifecycle: Create, update, and delete records in draft, and automate publishing workflows.
Data quality automation: Create and manage DQ rules and monitors, run DQ evaluations from your pipelines, retrieve the results and invalid samples, and set up DQ dashboards.
Data observability monitoring: Retrieve alerts, their findings, and the observed pipeline jobs and datasets.
System integration: Connect Ataccama ONE with your business applications, orchestration tools, and data pipelines.

Get started

Follow these steps to start using the API:

Set up authentication: Create an API client in the Ataccama Cloud Portal and obtain access tokens. See API Authentication.
Identify your resources: Find the URNs of the resources you want to work with (for example, table URNs or catalog item URNs).

You can list resources through the API or find them in the Ataccama ONE user interface. See URN Reference.

Make your first API call: Start with a simple GET request to list catalog items:

curl -X GET "https://{your-environment}.ataccama.one/api/catalog/v1/catalog-items" \
  -H "Authorization: Bearer {your-access-token}"

Explore API capabilities: Follow a guide under Walkthroughs, or find the endpoint group you need under Available APIs.

Walkthroughs

Step-by-step guides for tasks that combine several requests, with the decisions to make along the way. For the individual endpoints they use, follow the links to the API reference in each guide.

Data quality

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.

Reference data

Reference Data Lifecycle Management: Create, update, and delete records in draft, and publish directly or through review and approval.

Available APIs

Every endpoint is documented in the API reference, grouped as follows. Each link opens the endpoint group with its request parameters, response fields, error codes, schemas, and examples.

Catalog and glossary

Catalog items and attributes: Access and manage catalog items and their attributes, create SQL catalog items, and manage the terms assigned to attributes.
- Catalog items
- Catalog attributes
Folders: Organize SQL catalog items in the workspace of a source.
- Folders
Terms and detection rules: Manage the business glossary and the rules that drive automated term detection.
- Terms
- Detection rules
Sources: Manage the systems your data assets originate from.
- Sources
Stewardship: Read and change which group is responsible for your data assets.
- Stewardship
Documentation flows: Trigger metadata import, term detection, profiling, and data quality evaluation on a connection.
- Documentation flow
Generic metadata entities and the metadata model: Work with entities of any type defined in the metadata model, and discover the types and properties your environment defines.
- Generic metadata entities
- Metadata model entities

Data quality

Rules and monitors: Manage DQ rules and monitors, including batch creation.
- Data quality rules
- Data quality monitors
Processing and results: Start DQ monitor processing and retrieve the evaluation results and invalid samples.
- Data quality monitor processing
Dashboards: Create and publish DQ dashboards that aggregate the results of selected DQ monitors.
- Data quality dashboards
Dimensions and transformations: Look up the DQ dimensions and transformations that rules reference.
- Data quality dimensions
- Data quality transformations

Data observability and pipeline monitoring

Alerts and findings: Retrieve data observability alerts and the findings behind them.
- Alerts
- Findings
Pipeline monitoring: Retrieve the orchestrators, pipeline jobs, and datasets that findings reference.

Reference data

Reference data: Read published reference data, query it with SQL SELECT statements, work with draft records, and publish directly or through review and approval.
- Reference data

Transformations and processing

Transformation plans: Trigger execution of published transformation plans from your orchestration tools.
- Transformation plans
Processing: Track the asynchronous processing that other APIs start: poll a workflow, list and cancel workflows, and inspect their jobs.
- Workflows
- Jobs