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

2024.1.4 API Release Notes

New

Python SDK

Alation has released an open-source Python SDK to better enable working with Alation APIs. Check out the SDK documentation and the public GitHub repository.

Updated

BI Permissions

We've added BI folders and BI reports as supported object types for the Members Permission API and Privacy Settings API, so you can now control access to these object types using Alation APIs. (AL-159617)

Documents API

You can now specify which fields should be returned when getting documents. Do this by providing the query parameter values and supplying a comma-delimited list of fields that should be returned. Example:

http://<alation_url>.alationcloud.com/integration/v2/document/?limit=1000&values=id,title,folder_ids,document_hub_id

Limiting which fields are returned can speed up response times when fetching a large amount of objects. (AL-156335)

Folders API

You can now specify which fields should be returned when getting folders. Do this by providing the query parameter values and supplying a comma-delimited list of fields that should be returned. Example:

http://<alation_url>.alationcloud.com/integration/v2/folder/?limit=1000&values=id,title,template_id,document_hub_id

Limiting which fields are returned can speed up response times when fetching a large amount of objects. (AL-156335)

Deprecation Notices

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.

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 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 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)