Relational Integration APIs
Description
This API allows users to create and read technical and logical metadata together for virtual and non-virtual RDBMS data sources. Users with appropriate permissions can create schemas, tables and columns under a particular data source along with their custom fields.
This API's POST methods act as a POST and not a PATCH. All fields not included in a POST request will be set to a default value.
Permissions
| API Method | Private Data Source | Public Data Source |
|---|---|---|
| GET | Allowed for all user roles. | Allowed only for Server Admin, Catalog Admin, and Source Admin roles with access level as a Data Source Admin. |
| POST | Allowed for all user roles with access level as Data Source Viewer or Data Source Admin on the private data source. | Allowed only for Server Admin, Catalog Admin, and Source Admin roles with access level as a Data Source Admin. |
POST Payload Size Limits
In order to prevent API calls from overwhelming Alation, this API has limits on how many objects can be submitted in the payload of a POST method. This is a hard limitation that is not configurable. The limit depends on the object type, as shown in the table below.
| Object Type | Max Objects in POST Payload |
|---|---|
| Schema | 1,000 |
| Table | 1,000 |
| Column | 10,000 |
If you need to POST more objects than the limit allows, we recommend splitting the payload into smaller sizes and submitting multiple API calls.
Interactions with Other Alation Features
When you make changes using this API, Alation will not sent notifications to Stewards or watchers of the affected objects. This API bypasses workflows.
Changes made by this API will appear in Alation Analytics for the affected object and in the Data Governance dashboard.
OpenAPI 3.0 Specification
The Relational Integration APIs uses the OpenAPI 3.0 Specification (OAS). OAS is a broadly adopted industry standard for describing APIs.
To see the specification, replace {AlationInstanceURL} below with your Alation instance's URL and visit the link:
{AlationInstanceURL}/openapi/integration_apis/
NOTE:
- This API is available in Alation 2021.2 and later.
- The OpenAPI UI is not enabled by default on an Alation instance. Please set the flag
alation.feature_flags.enable_swaggertoTrueusingalation_conf.