HomeGuidesRecipesAPI Reference

API Release Notes

Suggest Edits

2022.3

New

  • Custom Field Value Async - Updated the objects that it supports as well as improved performance. We recommend using this API for modifying custom metadata when you have over 6000 objects for the following objects:
    • dataflow
    • domain
    • business_policy
    • filesystem
    • file
    • directory
    • policy
    • glossary_term
    • bi_server
    • bi_folder
    • bi_connection
    • bi_connection_column
    • bi_datasource
    • bi_datasource_column
    • bi_report
    • bi_report_column
    • bi_dimension
    • bi_measure
    • data
    • schema
    • table
    • attribute

🚧

Custom Field Value & Custom Field Value Async

These APIs will not allow you to update titles and descriptions on the the following object types. You will need to use the Relational Integration API Overview APIs to perform these actions.

  • data
  • schema
  • table
  • attribute

Updates

  • Custom Field Values Overview - updated to support the same object types as listed above for custom field values async.
  • Upload Logical Metadata API - Couple of changes here. If you have jobs that are using this API to update schemas, tables, file systems, and etc. this API will still work, but will not be as performant as the new Custom Field Values Async. We are now advising customers to only use this API for updating the metadata for the following otypes:
  • Upload Logical Metadata with Article ID - The workhorse API itself got an update that allows you to update articles by article id!
  • Lineage & Dataflows Overview - Post Dataflow, Patch Dataflow and Get Dataflow endpoints have an additional field group_name that can be updated.
    • group_name: The dataflow source group name, to be used by a future Alation feature, to which the dataflow belongs to. Case sensitive. If an exact match is found then it would be used, otherwise it will create a new dataflow source group. Example: "Snowflake-1".
  • Data Health Ingestion - Added new GET for fields and values. Supports query params:
    • Fields
      • filtering on key
      • ordering on order_by
      • limiting page with limit
      • skipping results with skip
    • Values
      • object_key
      • field_key
      • value_quality
      • order_by
      • skip
      • limit

Bug Fixes

2022.2

Updates

Lineage & Dataflows Overview

Enabled access for the Source Admin role to access the Lineage API. Previously, this API was only accessible to Server Admins.

Data Quality API

Added a new Data Health API (<your_Alation_URL>/openapi/data_quality/) that powers the Health Tab for Table Objects.

2022.1

Updates

Search

Users can now browse the contents of Domains using the GET method of the Search API <your_Alation_URL}/openapi/search/>. The GET endpoint now supports the domain_ids parameter, providing the ability to list member objects of a specific Domain.

Domain

  • The Domains API <your_Alation_URL}/openapi/domain/> now provides an endpoint to programmatically view which membership rules are applied to domains and subdomains: POST /domain/membership/.
  • Server and Catalog Admins can now delete Domain objects in bulk using the DELETE endpoint of the Domains API.

Datasource API Overview

The PUT endpoint of the Data Source API <your_Alation_URL}/openapi/datasources/> now has a new parameter compose_default_uri that allows users to update the Compose Default Connection URI field for a data source. This does not impact the Service Account URI of the data source.

2021.4

New

Domains Public API

  • Alation has added a public API for managing Domain objects. API users can shallow add or recursively add objects to Domains, create Domains in bulk, bulk-edit the Custom Fields, and remove objects from Domains using this API. The Domain API can be accessed by adding /openapi/domain/ to your instance URL

Bug Fixes

  • Jobs APIs - Fixed an issue where the Job API did not return the job status if the bulk upload payload included special characters.
  • Table Metadata Sync Trigger - Fixed an issue with the Table Metadata Sync API where using it resulted in the 500 error. The API now works as expected.
  • Data Sources API - Fixed an issue where this API returned an error when users attempted to update the Description field for an existing Data Source. Now, the Description field can be updated successfully.

2021.3

Updates

  • Article - Added support for enabling or disabling Agile Approval for Articles using the Articles API. Updated the Articles API documentation to include information about changing this setting.

Bug Fixes

  • Relational Integration API Overview - Updated the type of the field_id property of the object custom_field from string to integer in the specification of the Integration API.
  • Data Sources API - Fixed an issue where this API returned an error when users attempted to update the Description field for an existing Data Source. Now, the Description field can be updated successfully.
  • Table Metadata Sync Trigger - Fixed an issue with the Table Metadata Sync API where using it resulted in the 500 error. The API now works as expected.

2021.2

New

Relational Integration API Overview

  • Added the Integration API that brings together physical and logical catalog metadata for the Schema, Table, and Column objects, allowing users to retrieve and create these objects in Virtual or non-virtual RDBMS data sources in Alation. This API can be used by Source, Catalog, and Server Admins who are also assigned as Data Source Admins to the data source they are working with.
  • Using the RDBMS Integration API, you can:
    • Get a list of schemas, tables, and columns and their custom fields from virtual and non-virtual data sources;
    • Create physical (schemas, tables, columns) and logical metadata (custom field values) in non-virtual data sources.
    • Upload new and update existing physical (schemas, tables, columns) and logical (custom field values) metadata into a Virtual Data Source at the same time;
    • Get a list of schemas, tables, and columns characterized by specific custom fields.
    • The RDBMS Integration API documentation is available in the OAS 3.0 format at on your instance /openapi/integration_apis/ or Relational Integration API Overview.

Bug Fixes

  • Data Sources API - Fixed an issue where the PUT request of the Data Source API returned the Status 400 (Bad Request) error when users attempted to update the Description field for an existing Data Source. Now, the Description field can be updated successfully.
  • Query APIs - Retrieve queries failed if any queries in the result set had a schedule has been now fixed.

2021.1

New

Search API

New public API for retrieving Search data from the Catalog: you can now send requests to the GET Search API endpoint and retrieve search results. GET Search API documentation is available in the OAS 3.0 format at http(s)://<your_Alation_URL>/openapi/search/

  • The Search API offers the capability to interact with other applications used at your organization and to integrate the Alation Catalog into the existing application workflows.
  • Requires: the Swagger integration to be enabled: alation_conf alation.feature_flags.enable_swagger = True.
  • Added support for search timeouts and max retries. More documentation can be found here.

Bug Fixes

  • Custom Field Values Overview - Previously, the Open API specification of the Custom Field Values API incorrectly rendered the example for the PUT endpoint. This issue has now been fixed.

Updated about 1 month ago

Did this page help you?