Skip to main content
POST
Create a definition

Authorizations

Authorization
string
header
required

API key authentication using Bearer token format: Bearer <basedash_api_key>

Path Parameters

orgId
string
required

Organization ID

Body

application/json
name
string
required

Human-readable definition name

Required string length: 1 - 100
databaseConnectionId
string
required

Data source ID

sqlQuery
string
required

SQL query that defines the reusable dataset

Required string length: 1 - 100000
referenceName
string

Stable SQL reference name for the definition

Required string length: 1 - 100
description
string

Definition description

Maximum string length: 10000

Response

Definition created successfully

data
object
required