Skip to main content
PATCH
/
api
/
public
/
organizations
/
{orgId}
/
definitions
/
{id}
Update a definition
curl --request PATCH \
  --url https://charts.basedash.com/api/public/organizations/{orgId}/definitions/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "referenceName": "<string>",
  "description": "<string>",
  "sqlQuery": "<string>"
}
'
{
  "data": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "referenceName": "<string>",
    "description": "<string>",
    "sqlQuery": "<string>",
    "organizationId": "<string>",
    "databaseConnectionId": "<string>"
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

orgId
string
required

Organization ID

id
string
required

Definition ID

Body

application/json
name
string

Human-readable definition name

Required string length: 1 - 100
referenceName
string

Stable SQL reference name for the definition

Required string length: 1 - 100
description
string

Definition description

Maximum string length: 10000
sqlQuery
string

SQL query that defines the reusable dataset

Required string length: 1 - 100000

Response

Definition updated successfully

data
object
required