HomeGuidesRecipesAPI ReferencePython SDK
Alation Help Center
API Reference

Create new columns under a particular data source

This API allows creation of multiple columns under a table for a data source denoted by ds_id, along with their custom fields. The custom field ids can be obtained using the Custom Fields API (https://{base-url}/openapi/custom_field/). Please read the request schema for more information.

📘

The request body must be wrapped in an array.

Query Params
integer
required

Unique identifier of the data source

Body Params
string
required

Period delimited, Fully Qualified Name of a column. Format {DS_ID}.{SCHEMA_NAME}.{TABLE_NAME}.{COLUMN_NAME}} eg: "7.Human_Resources.Employees.First_Name", "7.catalog_name.schema_name.table_name.col_name"

string
required

The string describing the type of the column. eg. int, varchar(100)

string

Title of the column.

string

The description of the column.

string

A comment field that stores a description of the column which is ingested from the source system. eg. "Column has a default value"

boolean

Field to indicate if the column can contain null values. Set this to True if the column contains null value otherwise set it to False. Defaults to False. Note - Since it defaults to False, that means that this column cannot contain null values. The text NO NULLS appears in the column catalog page representing this behavior.

string

Position of the column in the table.

object

Define the index that the column is associated with.

array of objects

Custom fields that need to be uploaded for the column object. It is an array of custom field objects with field_id and value. See structure below.

Note : These custom fields first should be associated with the column otype
template. You can create and add a new custom field to the column otype template
from Customize Catalog option in the UI.

custom_fields
Responses

Language
Credentials
URL
Choose an example:
application/json