API Release Notes
See Finding Your Alation Version for help determining which version of Alation you're using.
2025.1.3 API Release Notes
Updated
Aggregated Context API
The Aggregated Context API (Beta) has been updated to work with queries that use a table and tables that are mentioned by a query.
- The
signature
parameter'squery
>fields_required
andquery
>fields_optional
properties can now specifymentioned_tables
as a required or optional field. Thequery
object now has achild_objects
property where you can specify which fields to return for tables that are mentioned by the query, as well as for child columns of those tables. - The
signature
parameter'stable
>fields_required
andtable
>fields_optional
properties can now specifycommon_queries
as a required or optional field. Thetable
>child_objects
property now has acommon_queries
property where you can specify which fields to return for queries that use the table. - When returning table information, the
relevant_tables
object will have a new property,common_queries
, that gives information about queries that commonly use the table. This property is not returned when tables are returned as children of another object. - When returning query information, the
relevant_queries
object will have a new property,mentioned_tables
, that gives information about tables used in the query. This property is not returned when queries are returned as children of another object.
(AL-187564)
Data Dictionary API
The Data Dictionary API's Get data dictionary task details endpoint has been updated to return information about partial successes. The following changes have been made to the endpoint's 200 response:
- The
status
property now returns a value ofPARTIALLY_SUCCEEDED
if some objects were updated correctly but some weren't. - A new property,
results
, contains details on the total number of rows in the data dictionary, the number that failed, and the number that succeeded. - A new property,
ts_created
, indicates when the task was created. - A new property,
ts_updated
, indicates when the task was last updated. - Properties of the
dd_resource
object have been renamed.- The
object_id
property has been renamed tooid
. - The
object_type
property has been renamed tootype
.
- The
- Properties of the
progress
object have been renamed.- The
total_number_of_batches
property has been renamed tototal_batches
. - The
number_of_batches_completed
property has been renamed tobatches_completed
.
- The
- We fixed some errors in the documentation:
- The property
report_download_link
was not documented. This property contains a link to download the report file. - The property
job_id
has been removed from the documentation. It was included in error. The response doesn't include this property.
- The property
(AL-175320)
Deprecation and sunset notices
Upload Logical Metadata (ULM) API
The Upload Logical Metadata (ULM) API has now been deprecated.
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. Migrate articles to Document Hubs and then use the Documents API. 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 |
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
- The ULM API is deprecated as of the 2025.1 Release (March 2025). Alation does not recommend using the ULM API. Use alternative APIs listed above instead.
- Temporary opt-outs of Logical Metadata Services enablement have also ceased as of 2025.1.
Customer-managed (on-premises)
- Alation does not recommend using the ULM API. Use alternative APIs listed above instead. The ULM API is deprecated as of 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.
Updated 16 days ago