HomeGuidesRecipesAPI ReferencePython SDK
Alation Help Center

API Release Notes

See Finding Your Alation Version for help determining which version of Alation you're using.

2024.1.1 API Release Notes

New

My Domains (Federated Catalog public preview)

  • As part of the Federated Catalog public preview, we've added the My Domains API, which allows Catalog Admins and Server Admins to assign users and groups to domains. Users can then filter the catalog navigation and search based on those domains. To use this API, you must have turned on Enable Federated Catalog Features on the Feature Configuration page in Admin Settings. (AL-121118)

    πŸ“˜

    Federated Catalog public preview

    To participate in the Federated Catalog public preview, you must have Beta language contained in your contract or have a Beta addendum signed.

Updated

Domains

Cross-System Lineage

  • The Cross-System Lineage API endpoints are being merged into the existing Lineage API, and new endpoints have been added for bulk operations as well as operations on individual resources. (AL-145817)

OCF Data Sources

  • You can now get and update all metadata extraction options for an OCF data source. Previously, you could only work with a small set of options. The additional options are accessible through a new configuration_parameters body parameter. (AL-148936)
  • When updating metadata extraction options, you can now Base64 encode parameter values, enabling you to send multi-line SQL queries, for example. To do this, make sure the base64 parameter is set to true in your JSON payload. (AL-149793, AL-148936)

Relational Integration

Data Dictionary

Fixed

  • For consistency with other APIs, the List Policy Groups endpoint now works with a trailing slash. It will also continue to work without a trailing slash. (AL-145478)

Deprecation Notices

Upload Logical Metadata (ULM) API

The ULM API will be deprecated in release 2024.3.1 in early October.

If you are using the ULM API, we recommend you move as soon as possible to using the newer, more performant Custom Field Values Async API or one of the other alternatives for your use case as shown below.

Object TypeFieldsAlternative API
ArticleTitle and bodyArticles API
ArticleCustom field valuesNone; continue to use the ULM API
Data source (OCF) objectTitle and descriptionData Sources API (OCF)
Data source (native) objectTitle and descriptionData Sources API
DocumentTitle, description, and
custom field values
Documents API
Schema, table, and columnTitle and descriptionRelational Integration API
Schema, table, and columnCustom field valuesCustom Field Values Async API
TermTitle, description, and
custom field values
Terms API
Other supported object typesCustom field valuesCustom Field Values Async API

Why is this happening? Alation is investing in scalable APIs and infrastructure that are no longer compatible with the ULM API. To give our customers the best experience, we will be focusing our efforts on more scalable alternatives as shown in the table above.

Custom Field Values Synchronous PUT

The PUT multiple Custom Field Values synchronous endpoint will be deprecated in release 2024.3.1 in early October. As an alternative, migrate to the PUT multiple Custom Field Values Async endpoint as soon as possible. The asynchronous endpoint is much more performant and provides a better experience.

OCF Data Sources API Parameters

For the Trigger metadata extraction job endpoint of the OCF Data Sources API, we will be deprecating the three body parameters limit_schemas , exclude_schemas, and remove_filtered_schemas. The deprecation will occur in release 2024.3 in early September. As an alternative, we recommend you use the Update metadata extraction configurations endpoint to configure the extraction and use the Trigger metadata extraction job endpoint to run the extraction. (AL-148936)

Cross-System Lineage API

The separate Cross-System Lineage API is being deprecated immediately, and its endpoints are being merged into the existing Lineage API.