HomeGuidesRecipesAPI ReferencePython SDK
Alation Help Center
API Reference
Alation Help Center

Custom Field Values Overview

Custom Field Value API (V2)

Description

The Custom Field Value PUT endpoint will be deprecated in 2024.3 in early September. Migrate to the Custom Field Value Async endpoint as soon as possible. It has exactly the same functionality but is more performant for large requests.

🚧

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 (refers to columns; can be used for custom field values; use the Relational Integration API for titles and descriptions)
  • 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 (refers to data sources; can be used for all custom field values; use the Relational Integration API for titles and descriptions)
  • dataflow
  • directory
  • doc_schema (NoSQL document schema)
  • docstore_collection (NoSQL collection)
  • docstore_folder (NoSQL database)
  • domain
  • dynamic_set_property (refers to catalog set objects)
  • file
  • filesystem
  • glossary_term (refers to document objects when Document Hubs is enabled, otherwise refers to terms)
  • glossary_v3(refers to folder objects when Document Hubs is enabled, otherwise refers to glossaries)
  • policy (only for data policies; for business policies, use business_policy)
  • policy_group
  • propagated_catalog_set (refers to catalog set shared fields)
  • schema (for custom field values; use the Relational Integration API for titles and descriptions)
  • table (for custom field values; use the Relational Integration API for titles and descriptions)

πŸ“˜

Catalog Sets

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.

Interactions with Other Alation Features

This API bypasses workflows.

When you make changes using this API, Alation will not send notifications to Stewards or watchers of the affected objects.

(https://docs.alationdata.com/en/latest/steward/Workflow/index.html).

Changes made by this API will appear in Alation Analytics for the affected object.

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/