ULM: Key Formatting

🚧

ULM Update

If you have jobs that are using this API to update schemas, tables, file systems, and etc. this API will still work, but it is not be as performant as the new Custom Field Values Async. This API is recommend for modifying articles.

Key Formatting

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

Object TypeValue Format
schema<datasource_id>.<schema_name>
Example: {"key":"1.emp_schema"}
table<datasource_id>.<schema_name>.<table_name>
Example: {"key":"1.emp_schema.employee"}
attribute/column<datasource_id>.<schema_name>.<table_name>.<column_name>
Example: {"key":"1.emp_schema.employee.emp_id"}
article<article_title>
Example: {"key":"Salary Description"}
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"}In the
Example: above, '/default/transaction/logs.csv' is the complete path to logs.csv inside the file system with id as 3
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.
Example: api_resource/25/ would be {"key": "25"}. You can programmatically pull these IDs via a GET call on the API Resources API.
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.
Example: api_resource/field/133/ would be {"key": "133"}. You can programmatically pull these IDs via a GET call on the API Resources API.
docstore_folder<datasource_id>.<docstore_folder_name>
Example: {"key": "1.folder_name"} where 1 is the unique identifier (id) 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 (id) 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 (id) 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