HomeGuidesRecipesAPI ReferencePython SDK
Alation Help Center
Guides
Alation Help Center

ULM: Key Formatting

Suggest Edits

🚧

Deprecation Notice

The Upload Logical Metadata (ULM) API will be deprecated in the 2024.3 release of Alation in early September. We recommend you move as soon as possible to the alternatives listed in the API Release Notes.

Key Formatting

The value format for key depends on the type of object for the Upload Logical Metadata API.

Object TypeValue Format
api_resourceIn Alation, go to the API that needs to have custom fields updated. Look in the address bar and take note that the address says api_resource and the ID number after the /. That ID number is the key. You can programmatically pull these IDs via a GET call on the API Resources API.
Example: {"key": "25"} where the address in Alation isapi_resource/25/.
api_resource_fieldIn Alation, go to the API field that needs to have custom fields updated. Look in the address bar and take note that the address says api_resource/field/ and the ID number after the /. That ID number is the key. You can programmatically pull these IDs via a GET call on the API Resources API.
Example: {"key": "133"} where the address in Alation isapi_resource/field/133/.
article<article_title>
Example: {"key":"Salary Description"}
attribute/column<datasource_id>.<schema_name>.<table_name>.<column_name>
Example: {"key":"1.emp_schema.employee.emp_id"}
docstore_folder<datasource_id>.<docstore_folder_name>
Example: {"key": "1.folder_name"} where 1 is the unique identifier of the data source and folder_name is the name of the DocStore folder which is updated.
docstore_collection\<datasource_id>.\<docstore_folder_name>.\<docstore_collection_name>
Example: {"key": "1.folder_name.collection_name"} where 1 is the unique identifier of the data source and folder_name.collection_name is the path of the DocStore collection to be updated.
doc_schema<datasource_id>.<docstore_folder_name>.<docstore_collection_name>.<doc_schema_name>[.<doc_schema_name>]
Example: {"key": "1.folder_name.collection_name.schema_name"} or {"key": "1.folder_name.collection_name.schema_name_1.schema_name_2.schema_name_3"} for deeply nested attributes, where 1 is the unique identifier of the data source and folder_name.collection_name.schema_name_1.schema_name_2.schema_name_3 is the path of the DocStore schema to be updated.
filesystem, directory, file<filesystem_id/[path_to_file]>
Note: path_to_file can be a path to either a directory (with the directory name included) inside the file system or a file (with the file name included).
Example: {"key":"3/default/transaction/logs.csv"} where /default/transaction/logs.csv is the complete path to logs.csv inside the file system with id as 3.
schema<datasource_id>.<schema_name>
Example: {"key":"1.emp_schema"}
table<datasource_id>.<schema_name>.<table_name>
Example: {"key":"1.emp_schema.employee"}

Updated 7 months ago