Cloud Portal ONE Desktop ONE DQ&C ONE MDM ONE RDM ONE Runtime Server
User Community Service Desk Downloads

REST API Overview

The REST API is currently in Early Access Preview. The API specification and endpoints might change before being marked as stable.

We recommend testing thoroughly and being prepared to adapt to potential changes in future releases.

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

What you can do with the API

In the current version, the REST API allows you to:

  • Read and query reference data: Access published reference data tables and records programmatically.

  • Manage data lifecycle: Create, update, and delete records in draft.

  • Automate publishing workflows: Publish changes directly or submit them for review and approval.

  • Integrate with external systems: Connect Ataccama ONE with your business applications and data pipelines.

Get started

Follow these steps to start using the API:

  1. Set up authentication

    Create an API client in the Ataccama Cloud Portal and obtain access tokens. See API Authentication.

  2. Identify your resources

    Find the URNs of the resources you want to work with (for example, table URNs). You can list resources through the API or find them in the Ataccama ONE user interface.

  3. Make your first API call

    Start with a simple GET request to list tables:

    GET https://{your-environment}.ataccama.one/api/reference-data/v1/tables
Authorization: Bearer {your-access-token}

  4. Explore workflows

    Learn how to manage the complete data lifecycle by following the examples in Reference Data Lifecycle Management.

Reference Data API

The Reference Data API provides complete lifecycle management for reference data tables:

The Reference Data API base URL is:

https://{your-environment}.ataccama.one/api/reference-data/v1

Authentication

All API requests are secured with industry-standard security protocols:

  • OAuth 2.0 Bearer Token Authentication: Uses the Client Credentials flow for secure machine-to-machine authentication.

  • TLS 1.3 Encryption: All API communication is encrypted using TLS 1.3 with AEAD-AES256-GCM-SHA384 cipher suite.

See API Authentication for detailed setup instructions for creating API clients and obtaining access tokens.

Pagination and filtering

List endpoints support cursor-based pagination for efficient handling of large datasets. Results include pagination metadata with prev and next cursors.

Filter endpoints support complex queries with:

  • Attribute-based filtering (string, number, date, Boolean).

  • Logical operators (AND, OR).

  • Comparison operators (such as equals, contains, greater than).

  • Record state filtering (such as NEW, CHANGED, DELETED).

API design

The API follows REST principles with:

  • Standard HTTP methods (GET, POST, DELETE).

  • JSON request and response formats.

  • Meaningful HTTP status codes.

  • Resource-based URLs.

API versioning

The API uses URL-based versioning (for example, /v1/) to ensure backward compatibility. The current version is v1.

When new versions are released:

  • Existing versions remain supported for a minimum period.

  • Breaking changes are introduced only in new versions.

  • You can migrate to new versions at your own pace.

Best practices

  • Reuse access tokens: Access tokens remain valid for a period of time. Reuse them instead of requesting a new token for each API call.

  • Use pagination: When retrieving large datasets, use pagination parameters to fetch data in manageable chunks.

  • Filter at the API level: Use filter parameters to retrieve only the data you need, reducing payload sizes and improving performance.

  • Handle errors gracefully: Implement proper error handling to manage API errors effectively.

OpenAPI specification

Download the complete OpenAPI 3.1 specification for detailed API reference, including all endpoints, parameters, request/response schemas, and examples.

Getting help

If you encounter issues or have questions:

  • Check the troubleshooting sections in the API documentation.

  • Review error responses for detailed problem descriptions.

  • Contact Ataccama Support with your environment details and relevant error messages.

Was this page useful?