HomeGuidesRecipesAPI ReferencePython SDK
Alation Help Center
API Reference

Create new tables under a particular data source

This API allows creation of multiple tables under a schema 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. This endpoint should not be used to update data objects. All fields not included in the request will be set to a default value.

📘

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 table. Format {DS_ID}.{SCHEMA_NAME}.{TABLE_NAME} eg: "7.Human Resources.Employees", "7.catalog_name.Human_Resources.Employees"

string

Title of the table.

string

The description of the table.

string

Comments/information on the table from the source database. Defaults to empty text if not passed in the request.

string

The type of the table. Value can be TABLE, VIEW or SYNONYM. Defaults to TABLE.

string

The datasource specific name. eg. MATERIALIZED_VIEW, EXTERNAL_TABLE, ...

string

Name of the database account that owns this table.

string

Data definition language (SQL query) associated with table or view.

string

The API key for referencing the base table when the table type is a SYNONYM. Note: Make sure the base_table_key is a valid and exists in the catalog.

string

The name/information of the partition from the source database.

array of strings
partition_columns
array of objects

Custom fields that need to be uploaded for the table 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 table otype
template. You can create and add a new custom field to the table otype template
from Customize Catalog option in the UI.

custom_fields
Responses

Language
Credentials
URL
Choose an example:
application/json