HomeGuidesRecipesAPI ReferencePython SDK
Alation Help Center
API Reference
Alation Help Center
Start typing to search…
These docs are for v2023.3.5. Click to read the latest docs for v2025.1.

Create new schemas under a particular data source

post {protocol}://{base-url}/integration/v2/schema/

This API allows creation of multiple schemas 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 schema. Format {DS_ID}.{SCHEMA_NAME} eg: "7.Human Resources", "7.HR.2017" (Schema name with a period)

string

Title of the schema.

string

The description of the schema.

string

Comments on the schema from the data source.

custom_fields
array of objects

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

custom_fields
Responses

Updated over 1 year ago

Did this page help you?
Language
Credentials
URL
Choose an example:
application/json

Updated over 1 year ago

Did this page help you?