HomeGuidesRecipesAPI Reference
Alation Help Center
Alation Help Center

Custom Field Values Overview

Custom Field Value API (V2)

Description

Both Custom Field Value & Custom Field Value Async will allow you to update the custom metadata fields on the below objects. We recommend using the Custom Field Value Async API for modifying custom metadata when you have over 6000 objects to update. It is more performant. Custom Field Value will be deprecated in the 2024.3 release in early September.

🚧

Titles & Descriptions

The Custom Field Value 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 to perform these actions.

  • data
  • schema
  • table
  • attribute

You can use this API to update other custom field values besides titles and descriptions for these objects.

Supported Object Types

  • api_resource
  • api_resource_field
  • api_resource_folder
  • attribute (Column, all custom field values except title or description)
  • bi_connection
  • bi_connection_column
  • bi_datasource
  • bi_datasource_column
  • bi_dimension
  • bi_folder
  • bi_measure
  • bi_report
  • bi_report_column
  • bi_server
  • business_policy
  • data (Data Source, all custom field values except title or description)
  • dataflow
  • directory
  • doc_schema
  • docstore_collection
  • docstore_folder
  • domain
  • dynamic_set_property (Catalog Set, available starting in 2023.1.2)
  • file
  • filesystem
  • glossary_term
  • policy
  • policy_group
  • propagated_catalog_set (Catalog Set shared field, available starting in 2023.1.2)
  • schema (all custom field values except title or description)
  • table (all custom field values except title or description)

📘

Catalog Sets

In 2023.1.2, we are adding support for Catalog Sets to this API. Catalog Sets have two object types:

  • dynamic_set_property—This is the Catalog Set object itself. Use this object type to update the Catalog Set's title and description.
  • propagated_catalog_set—This refers to shared fields associated with a Catalog Set. Use this object type to update shared field values that belong to a Catalog Set.

OpenAPI 3.0 Specification

The Custom Field Value API uses the OpenAPI 3.0 Specification (OAS). OAS is a broadly adopted industry standard for describing APIs.

To see the specification, replace {AlationInstanceURL} below with your Alation instance's URL and visit the link:

  • {AlationInstanceURL}/openapi/custom_field_value/
  • {AlationInstanceURL}/openapi/custom_field_value/ async/