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

2024.3.2 API Release Notes

Updated

Documents API

With the introduction of hierarchies to Document Hubs, the Documents API has new parameters to identify a document's parent and the folders that it has navigation links to.

Terms API

With the introduction of hierarchies to Document Hubs, the Terms API has new parameters to identify a term's parent and the folders that it has navigation links to.

📘
Even if you haven't enabled Document Hubs in your instance, Glossaries and Terms use the same architecture and behave the same as Document Hubs.

Workflows API

If a workflow applies to document or folder objects, the Workflows API now returns information about the Document Hub that they belong to. (AL-169049)

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)

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.

Upload Logical Metadata (ULM) API

Previously, the deprecation of the Upload Logical Metadata (ULM) API was announced as part of the 2024.3.1 Alation release (October 2024). Per customer feedback, we have decided to change the deprecation and sunset timeline of the ULM API.

Definitions

Deprecation: The API is no longer supported. The API will still be accessible to end users.
Sunset: The API is no longer supported. The API will be removed from the product and will no longer function.

What is happening

ULM Deprecation: 2025.1 Release (March 2025)
ULM Sunset: 2025.3 Release (September 2025)

What to expect

Alation does not recommend the usage of the ULM API. Use the alternative APIs listed in the table below instead.
Alation will no longer prioritize support efforts on the ULM API after the 2025.1 release and reserves the right to decline support requests.

If you have any questions, please contact Alation Support.

Alternative APIs

Object Type	Fields	Alternative API
Article	Title and body	Articles API
Article	Custom field values	None. See Risks with the ULM API.
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 these changes are being made

Customers have expressed concerns with the existing deprecation timeline in 2024.3.1 because there is no acceptable alternative for updating custom field values on articles. We want to make the transition easier for article custom field values by ensuring both Document Hubs and article migration utilities are generally available (GA) before the ULM API deprecation goes into effect.

Document Hubs GA: 2024.3.2 Release (November 2024)
Article migration utilities GA: 2024.3.3 Release (December 2024)

Risks with the ULM API

Alation Cloud Services (ACS) customers using the Upload Logical Metadata (ULM) API may not see Title, Description, or Custom Field Value updates reflected correctly in the Alation UI.

Why this is a risk

Alation is enabling Logical Metadata Services for all customers on ACS. This is a new infrastructure designed to bring performance and scalability benefits anywhere title, description, and custom field value metadata is involved. When Logical Metadata Services are enabled, the Alation UI serves content from Logical Metadata Services, instead of a legacy infrastructure. Updates made via the Upload Logical Metadata (ULM) API reflect in the legacy infrastructure only, and are not supported by Logical Metadata Services.

What are my options

Alation Cloud Service

Alation does not recommend using the ULM API. Use alternative APIs listed above instead. The ULM API is planned for deprecation in the 2025.1 Release (March 2025).
Reach out to Alation Support and request a temporary opt-out of Logical Metadata Services enablement.
Temporary opt-outs will be granted until deprecation in the 2025.1 release (March 2025).

Customer-managed (on-premises)

Alation does not recommend using the ULM API. Use alternative APIs listed above instead. The ULM API is planned for deprecation in the 2025.1 Release (March 2025).
No action is required regarding Logical Metadata Services enablement. Logical Metadata Services are not available in customer-managed instances of Alation.