HomeGuidesRecipesAPI ReferencePython SDK
Alation Help Center
API Reference

Upload a data dictionary

Updates catalog object with the metadata provided in the data dictionary file. This endpoint can only be used by the Composer role and above by default. Setting the parameter alation.feature_flags.disable_perm_check_on_upload_dd to true in alation_conf disables permission checks during the upload process, which may improve performance, and also makes it so only Catalog Admins and Server Admins can use this endpoint.

Recipes
🦉
Upload Data Dictionaries
Open Recipe

Before using this API, the alation_conf parameter alation.feature_flags.dev_enable_data_dictionary_redesign should be set to true. This parameter is set to true by default starting in 2023.3.2. For help using alation_conf, see Using alation_conf.

You can include columns in the data dictionary upload file, as long as you also include one of the higher-level objects (data source, schema, or table).

See Importing a Data Dictionary in the Alation docs for details on how to format the data dictionary file.

Path Params
string
required

Object type of the target catalog object to be updated. Supported object types are data (data source), schema, and table.

number
required

Object ID of the target catalog object to be updated. This parameter corresponds to the "object_type" parameter specified in the path. The target catalog object represented by "object_type" and "object_id" parameters should be a logical parent or top level object of the input records or objects contained in the data dictionary file.

Body Params
boolean

Indicates whether to overwrite the existing value with the provided value or to keep the existing value intact. This parameter is applicable only when provided value is valid, i.e, if user has not provided any valid value in data dictionary file, then such field would be ignored and will not be eligible for any update. Regardless of this parameter, if the respective field does not contain any valid value and user has provided valid value in data dictionary file, then the respective field will be updated with the provided value. In general, blank values provided in data dictionary file will be ignored and removal of an existing value from any field is not supported.

file

A data dictionary file to be uploaded in multipart request form. Uploaded file should be in either CSV or TSV format with respective extension. Uploaded file size should not exceed 25 MB.

Responses

409

Conflict

410

Gone

422

Unprocessable entity

424

Failed dependency

429

Too many requests

Language
Credentials
URL
Choose an example:
application/json