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

2024.3.1 API Release Notes

Fixed

Domains API

The Domains API has a max limit of 99 objects when doing a POST request to add objects to a domain recursively. Previously, exceeding the limit was incorrectly generating a 500 response. In addition, the limit was not mentioned in the documentation. Exceeding the limit now generates a 400 response, and the limit has been added to the documentation.

Lineage API

The documentation has been corrected to indicate that the key field for dataflow and lineage POST calls is an open string field rather than an enum.

OCF Data Sources API

The documentation has been updated so it's easier to form a valid request body for the /datasource/{datasource_id}/configuration/ endpoint.

Relational Integration API

Previously, the documentation for the POST methods indicated that multiple values could be added to Reference custom fields. This has now been corrected to indicate that Reference custom fields can only have one value.

Known Issues

Custom Field Values API

The Custom Field Value API may not accept a custom field value that's more than 170 KB in size.

Deprecation Notices

OCF Data Sources API Parameters

For the Trigger metadata extraction job endpoint of the OCF Data Sources API, we have deprecated the three body parameters limit_schemas , exclude_schemas, and remove_filtered_schemas. 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)

Upload Logical Metadata (ULM) API

The ULM API has been deprecated as of release 2024.3.1.

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 Type	Fields	Alternative API
Article	Title and body	Articles API
Article	Custom field values	See What about articles? below.
Data source (OCF) object	Title and description	Data Sources API (OCF)
Data source (native) object	Title and description	Data Sources API
Document	Title, description, and custom field values	Documents API
Schema, table, and column	Title and description	Relational Integration API
Schema, table, and column	Custom field values	Custom Field Values Async API
Term	Title, description, and custom field values	Terms API
Other supported object types	Custom field values	Custom 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.

What about articles?

Alation is replacing articles with Document Hubs. Articles will eventually be deprecated, and Alation will provide a migration path to Document Hubs. No deprecation date for articles has been announced at this time. For now, you can continue to use the ULM API to update custom field values on articles, until the ULM API is sunset. The sunset timeline will be communicated to customers at a later date.

Custom Field Values Synchronous PUT

The PUT multiple Custom Field Values synchronous endpoint has been deprecated as of release 2024.3.1. 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.

NoSQL API v1

Version 1 of the NoSQL API will be deprecated in release 2024.3.2 in early November 2024. Start using the newer NoSQL API v2 as soon as possible.