API Release Notes

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

2025.1.4 API Release Notes

Updated

Aggregated Context API

  • The Aggregated Context API (Beta) now has a mode to retrieve objects in bulk. A new mode parameter lets you specify either search or bulk.
    • The default is search and returns a set of relevant objects based on a natural language question.
    • By specifying bulk, you can get a set of objects directly, as defined by the signature. In bulk mode, the question parameter must not be used, and signature is required. Documentation objects (documents and folders) aren't supported in bulk mode.
  • We've added a limit field to the signature object. In search mode, the default limit is 2 objects per type. In bulk mode, the default limit is 50 objects per type. You can set limit to return up to 1,000 objects per type.

(AL-194887)

BI Sources API

We've added a new eid parameter that you can use to delete datasources whose ID contains a comma. (AL-191027)

Tags API

We've added a new parameter, exclude_deleted, allowing users to filter responses and exclude deleted subjects. (AL-190688)

Trust Check Flags API

We've enhanced the API with two improvements

  • exclude_deleted parameter: A new parameter, exclude_deleted, has been added, allowing users to filter responses and exclude deleted subjects.
  • is_deleted field in success response: The is_deleted field has been added to the body of the success response. This field indicates whether a subject has been deleted, providing immediate status visibility. (AL-119593)

Fixed

Jobs API

The Jobs API will now return a 400 error when the id is set to None. (AL-192340)

Deprecation and sunset notices

Upload Logical Metadata (ULM) API

After reviewing customer feedback, we have decided to pause the deprecation of the ULM API until we have reviewed and improved the alternative APIs to enable a smoother transition. Alation will continue to support the ULM API until that time, but highly recommends that you switch to using the alternative APIs listed below.

📘

Alation Cloud Services and the ULM API

Alation Cloud Services (ACS) customers who have Logical Metadata Service (LMS) enabled on their tenants should use the alternative APIs since using the Upload Logical Metadata (ULM) API may result in issues with the correct display of title, description, or custom field value updates on catalog pages.

Alternatives to the ULM API

Object TypeFieldsAlternative API
ArticleTitle and bodyArticles API
ArticleCustom field valuesNone. Migrate articles to Document Hubs and then use the Documents API.
Data source (OCF) objectTitle and descriptionData Sources API (OCF)
Data source (native) objectTitle and descriptionData Sources API
DocumentTitle, description, and custom field valuesDocuments API
Schema, table, and columnTitle and descriptionRelational Integration API
Schema, table, and columnCustom field valuesCustom Field Values Async API
TermTitle, description, and custom field valuesTerms API
Other supported object typesCustom field valuesCustom Field Values Async API