Upload a data dictionary

put

{protocol}://{base-url}/integration/v1/data_dictionary/{object_type}/{object_id}/upload/

Updates catalog object with the metadata provided in the data dictionary file. In order to set a value in the catalog, the following requirements must be met.
(1) The object being updated must be present in Alation.
(2) Custom field names must be valid and present in the catalog.
(3) The user performing the API call must have edit permissions on the field in question.
(4) The field being updated must belong to the object's template.
(5) The value provided must be a valid data type for the field.

This endpoint can only be used by the Composer role and above by default.
Setting the alation_conf parameter alation.feature_flags.disable_perm_check_on_upload_dd to true disables field-level 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.
For help using alation_conf, see Using alation_conf.

Path Params

object_type

string

enum

required

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

Allowed:

object_id

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

overwrite_values

boolean

required

Determines whether to overwrite an existing value in the catalog if a new value is provided in the data dictionary file. If set to false, existing values in the catalog will be preserved, and values provided in the data dictionary will be ignored. If set to true, existing values will be overwritten by provided values. Invalid values will be ignored. If the provided value is blank, the behavior is determined by the allow_reset parameter. Fields in the catalog with no existing value will always be updated with the provided value, regardless of this parameter.

allow_reset

boolean

Defaults to false

This parameter only takes effect if overwrite_values is set to true. This parameter determines whether existing field values in the catalog should be reset (deleted) when the data dictionary file provides a blank value. If set to true, blank values provided in the data dictionary will reset existing field values. If set to false, blank values in the data dictionary file will be ignored, and the existing value in the catalog will be preserved. Defaults to false.

file

required

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

202Details of the asynchronous task registered for processing the uploaded data dictionary file.

400Malformed Request

401Unauthorized bad/missing token

403Forbidden User cannot edit this resource

404The specified resource was not found

500Internal Server Error