Update a model

Update a model

curl --request PATCH \
  --url https://charts.basedash.com/api/public/organizations/{orgId}/models/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "referenceName": "<string>",
  "description": "<string>",
  "sqlQuery": "<string>",
  "measures": [
    {
      "name": "<string>",
      "sql": "<string>",
      "description": "<string>",
      "synonyms": [
        "<string>"
      ]
    }
  ],
  "segments": [
    {
      "name": "<string>",
      "sql": "<string>",
      "description": "<string>",
      "synonyms": [
        "<string>"
      ]
    }
  ],
  "defaultTimeColumn": "<string>",
  "synonyms": [
    "<string>"
  ],
  "grain": "<string>",
  "keyColumns": [
    "<string>"
  ],
  "relationships": [
    {
      "targetModelId": "<string>",
      "sourceColumn": "<string>",
      "targetColumn": "<string>"
    }
  ],
  "usageGuidance": "<string>",
  "columnSynonyms": [
    {
      "name": "<string>",
      "synonyms": [
        "<string>"
      ]
    }
  ],
  "verified": true
}
'

import requests

url = "https://charts.basedash.com/api/public/organizations/{orgId}/models/{id}"

payload = {
    "name": "<string>",
    "referenceName": "<string>",
    "description": "<string>",
    "sqlQuery": "<string>",
    "measures": [
        {
            "name": "<string>",
            "sql": "<string>",
            "description": "<string>",
            "synonyms": ["<string>"]
        }
    ],
    "segments": [
        {
            "name": "<string>",
            "sql": "<string>",
            "description": "<string>",
            "synonyms": ["<string>"]
        }
    ],
    "defaultTimeColumn": "<string>",
    "synonyms": ["<string>"],
    "grain": "<string>",
    "keyColumns": ["<string>"],
    "relationships": [
        {
            "targetModelId": "<string>",
            "sourceColumn": "<string>",
            "targetColumn": "<string>"
        }
    ],
    "usageGuidance": "<string>",
    "columnSynonyms": [
        {
            "name": "<string>",
            "synonyms": ["<string>"]
        }
    ],
    "verified": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    referenceName: '<string>',
    description: '<string>',
    sqlQuery: '<string>',
    measures: [
      {
        name: '<string>',
        sql: '<string>',
        description: '<string>',
        synonyms: ['<string>']
      }
    ],
    segments: [
      {
        name: '<string>',
        sql: '<string>',
        description: '<string>',
        synonyms: ['<string>']
      }
    ],
    defaultTimeColumn: '<string>',
    synonyms: ['<string>'],
    grain: '<string>',
    keyColumns: ['<string>'],
    relationships: [
      {targetModelId: '<string>', sourceColumn: '<string>', targetColumn: '<string>'}
    ],
    usageGuidance: '<string>',
    columnSynonyms: [{name: '<string>', synonyms: ['<string>']}],
    verified: true
  })
};

fetch('https://charts.basedash.com/api/public/organizations/{orgId}/models/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://charts.basedash.com/api/public/organizations/{orgId}/models/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'referenceName' => '<string>',
    'description' => '<string>',
    'sqlQuery' => '<string>',
    'measures' => [
        [
                'name' => '<string>',
                'sql' => '<string>',
                'description' => '<string>',
                'synonyms' => [
                                '<string>'
                ]
        ]
    ],
    'segments' => [
        [
                'name' => '<string>',
                'sql' => '<string>',
                'description' => '<string>',
                'synonyms' => [
                                '<string>'
                ]
        ]
    ],
    'defaultTimeColumn' => '<string>',
    'synonyms' => [
        '<string>'
    ],
    'grain' => '<string>',
    'keyColumns' => [
        '<string>'
    ],
    'relationships' => [
        [
                'targetModelId' => '<string>',
                'sourceColumn' => '<string>',
                'targetColumn' => '<string>'
        ]
    ],
    'usageGuidance' => '<string>',
    'columnSynonyms' => [
        [
                'name' => '<string>',
                'synonyms' => [
                                '<string>'
                ]
        ]
    ],
    'verified' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://charts.basedash.com/api/public/organizations/{orgId}/models/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"referenceName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"sqlQuery\": \"<string>\",\n  \"measures\": [\n    {\n      \"name\": \"<string>\",\n      \"sql\": \"<string>\",\n      \"description\": \"<string>\",\n      \"synonyms\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"segments\": [\n    {\n      \"name\": \"<string>\",\n      \"sql\": \"<string>\",\n      \"description\": \"<string>\",\n      \"synonyms\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"defaultTimeColumn\": \"<string>\",\n  \"synonyms\": [\n    \"<string>\"\n  ],\n  \"grain\": \"<string>\",\n  \"keyColumns\": [\n    \"<string>\"\n  ],\n  \"relationships\": [\n    {\n      \"targetModelId\": \"<string>\",\n      \"sourceColumn\": \"<string>\",\n      \"targetColumn\": \"<string>\"\n    }\n  ],\n  \"usageGuidance\": \"<string>\",\n  \"columnSynonyms\": [\n    {\n      \"name\": \"<string>\",\n      \"synonyms\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"verified\": true\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://charts.basedash.com/api/public/organizations/{orgId}/models/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"referenceName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"sqlQuery\": \"<string>\",\n  \"measures\": [\n    {\n      \"name\": \"<string>\",\n      \"sql\": \"<string>\",\n      \"description\": \"<string>\",\n      \"synonyms\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"segments\": [\n    {\n      \"name\": \"<string>\",\n      \"sql\": \"<string>\",\n      \"description\": \"<string>\",\n      \"synonyms\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"defaultTimeColumn\": \"<string>\",\n  \"synonyms\": [\n    \"<string>\"\n  ],\n  \"grain\": \"<string>\",\n  \"keyColumns\": [\n    \"<string>\"\n  ],\n  \"relationships\": [\n    {\n      \"targetModelId\": \"<string>\",\n      \"sourceColumn\": \"<string>\",\n      \"targetColumn\": \"<string>\"\n    }\n  ],\n  \"usageGuidance\": \"<string>\",\n  \"columnSynonyms\": [\n    {\n      \"name\": \"<string>\",\n      \"synonyms\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"verified\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://charts.basedash.com/api/public/organizations/{orgId}/models/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"referenceName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"sqlQuery\": \"<string>\",\n  \"measures\": [\n    {\n      \"name\": \"<string>\",\n      \"sql\": \"<string>\",\n      \"description\": \"<string>\",\n      \"synonyms\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"segments\": [\n    {\n      \"name\": \"<string>\",\n      \"sql\": \"<string>\",\n      \"description\": \"<string>\",\n      \"synonyms\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"defaultTimeColumn\": \"<string>\",\n  \"synonyms\": [\n    \"<string>\"\n  ],\n  \"grain\": \"<string>\",\n  \"keyColumns\": [\n    \"<string>\"\n  ],\n  \"relationships\": [\n    {\n      \"targetModelId\": \"<string>\",\n      \"sourceColumn\": \"<string>\",\n      \"targetColumn\": \"<string>\"\n    }\n  ],\n  \"usageGuidance\": \"<string>\",\n  \"columnSynonyms\": [\n    {\n      \"name\": \"<string>\",\n      \"synonyms\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"verified\": true\n}"

response = http.request(request)
puts response.read_body

{
  "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>",
    "verifiedAt": "2023-11-07T05:31:56Z",
    "verifiedByMemberId": "<string>",
    "columns": [
      {
        "name": "<string>",
        "type": "array",
        "nullable": true,
        "example": "<string>",
        "description": "<string>",
        "synonyms": [
          "<string>"
        ],
        "sampleValues": [
          "<string>"
        ]
      }
    ],
    "measures": [
      {
        "name": "<string>",
        "sql": "<string>",
        "description": "<string>",
        "synonyms": []
      }
    ],
    "segments": [
      {
        "name": "<string>",
        "sql": "<string>",
        "description": "<string>",
        "synonyms": []
      }
    ],
    "defaultTimeColumn": "<string>",
    "synonyms": [
      "<string>"
    ],
    "grain": "<string>",
    "keyColumns": [
      "<string>"
    ],
    "relationships": [
      {
        "targetModelId": "<string>",
        "sourceColumn": "<string>",
        "targetColumn": "<string>",
        "cardinality": "many_to_one"
      }
    ],
    "usageGuidance": "<string>",
    "warnings": [
      {
        "code": "base_sql_contains_group_by",
        "message": "<string>",
        "field": "sqlQuery",
        "name": "<string>"
      }
    ]
  }
}

{
  "error": {
    "title": "<string>",
    "detail": "<string>"
  }
}

{
  "error": {
    "title": "<string>",
    "detail": "<string>"
  }
}

{
  "error": {
    "title": "<string>",
    "detail": "<string>"
  }
}

{
  "error": {
    "title": "Conflict",
    "detail": "<string>",
    "referenceName": "<string>",
    "suggestedReferenceName": "<string>"
  }
}

{
  "error": {
    "title": "RateLimitExceeded",
    "detail": "<string>",
    "retryAfterMs": 123
  }
}

{
  "error": {
    "title": "<string>",
    "detail": "<string>"
  }
}

PATCH

api

public

organizations

{orgId}

models

{id}

Update a model

curl --request PATCH \
  --url https://charts.basedash.com/api/public/organizations/{orgId}/models/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "referenceName": "<string>",
  "description": "<string>",
  "sqlQuery": "<string>",
  "measures": [
    {
      "name": "<string>",
      "sql": "<string>",
      "description": "<string>",
      "synonyms": [
        "<string>"
      ]
    }
  ],
  "segments": [
    {
      "name": "<string>",
      "sql": "<string>",
      "description": "<string>",
      "synonyms": [
        "<string>"
      ]
    }
  ],
  "defaultTimeColumn": "<string>",
  "synonyms": [
    "<string>"
  ],
  "grain": "<string>",
  "keyColumns": [
    "<string>"
  ],
  "relationships": [
    {
      "targetModelId": "<string>",
      "sourceColumn": "<string>",
      "targetColumn": "<string>"
    }
  ],
  "usageGuidance": "<string>",
  "columnSynonyms": [
    {
      "name": "<string>",
      "synonyms": [
        "<string>"
      ]
    }
  ],
  "verified": true
}
'

import requests

url = "https://charts.basedash.com/api/public/organizations/{orgId}/models/{id}"

payload = {
    "name": "<string>",
    "referenceName": "<string>",
    "description": "<string>",
    "sqlQuery": "<string>",
    "measures": [
        {
            "name": "<string>",
            "sql": "<string>",
            "description": "<string>",
            "synonyms": ["<string>"]
        }
    ],
    "segments": [
        {
            "name": "<string>",
            "sql": "<string>",
            "description": "<string>",
            "synonyms": ["<string>"]
        }
    ],
    "defaultTimeColumn": "<string>",
    "synonyms": ["<string>"],
    "grain": "<string>",
    "keyColumns": ["<string>"],
    "relationships": [
        {
            "targetModelId": "<string>",
            "sourceColumn": "<string>",
            "targetColumn": "<string>"
        }
    ],
    "usageGuidance": "<string>",
    "columnSynonyms": [
        {
            "name": "<string>",
            "synonyms": ["<string>"]
        }
    ],
    "verified": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    referenceName: '<string>',
    description: '<string>',
    sqlQuery: '<string>',
    measures: [
      {
        name: '<string>',
        sql: '<string>',
        description: '<string>',
        synonyms: ['<string>']
      }
    ],
    segments: [
      {
        name: '<string>',
        sql: '<string>',
        description: '<string>',
        synonyms: ['<string>']
      }
    ],
    defaultTimeColumn: '<string>',
    synonyms: ['<string>'],
    grain: '<string>',
    keyColumns: ['<string>'],
    relationships: [
      {targetModelId: '<string>', sourceColumn: '<string>', targetColumn: '<string>'}
    ],
    usageGuidance: '<string>',
    columnSynonyms: [{name: '<string>', synonyms: ['<string>']}],
    verified: true
  })
};

fetch('https://charts.basedash.com/api/public/organizations/{orgId}/models/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://charts.basedash.com/api/public/organizations/{orgId}/models/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'referenceName' => '<string>',
    'description' => '<string>',
    'sqlQuery' => '<string>',
    'measures' => [
        [
                'name' => '<string>',
                'sql' => '<string>',
                'description' => '<string>',
                'synonyms' => [
                                '<string>'
                ]
        ]
    ],
    'segments' => [
        [
                'name' => '<string>',
                'sql' => '<string>',
                'description' => '<string>',
                'synonyms' => [
                                '<string>'
                ]
        ]
    ],
    'defaultTimeColumn' => '<string>',
    'synonyms' => [
        '<string>'
    ],
    'grain' => '<string>',
    'keyColumns' => [
        '<string>'
    ],
    'relationships' => [
        [
                'targetModelId' => '<string>',
                'sourceColumn' => '<string>',
                'targetColumn' => '<string>'
        ]
    ],
    'usageGuidance' => '<string>',
    'columnSynonyms' => [
        [
                'name' => '<string>',
                'synonyms' => [
                                '<string>'
                ]
        ]
    ],
    'verified' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://charts.basedash.com/api/public/organizations/{orgId}/models/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"referenceName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"sqlQuery\": \"<string>\",\n  \"measures\": [\n    {\n      \"name\": \"<string>\",\n      \"sql\": \"<string>\",\n      \"description\": \"<string>\",\n      \"synonyms\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"segments\": [\n    {\n      \"name\": \"<string>\",\n      \"sql\": \"<string>\",\n      \"description\": \"<string>\",\n      \"synonyms\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"defaultTimeColumn\": \"<string>\",\n  \"synonyms\": [\n    \"<string>\"\n  ],\n  \"grain\": \"<string>\",\n  \"keyColumns\": [\n    \"<string>\"\n  ],\n  \"relationships\": [\n    {\n      \"targetModelId\": \"<string>\",\n      \"sourceColumn\": \"<string>\",\n      \"targetColumn\": \"<string>\"\n    }\n  ],\n  \"usageGuidance\": \"<string>\",\n  \"columnSynonyms\": [\n    {\n      \"name\": \"<string>\",\n      \"synonyms\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"verified\": true\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://charts.basedash.com/api/public/organizations/{orgId}/models/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"referenceName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"sqlQuery\": \"<string>\",\n  \"measures\": [\n    {\n      \"name\": \"<string>\",\n      \"sql\": \"<string>\",\n      \"description\": \"<string>\",\n      \"synonyms\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"segments\": [\n    {\n      \"name\": \"<string>\",\n      \"sql\": \"<string>\",\n      \"description\": \"<string>\",\n      \"synonyms\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"defaultTimeColumn\": \"<string>\",\n  \"synonyms\": [\n    \"<string>\"\n  ],\n  \"grain\": \"<string>\",\n  \"keyColumns\": [\n    \"<string>\"\n  ],\n  \"relationships\": [\n    {\n      \"targetModelId\": \"<string>\",\n      \"sourceColumn\": \"<string>\",\n      \"targetColumn\": \"<string>\"\n    }\n  ],\n  \"usageGuidance\": \"<string>\",\n  \"columnSynonyms\": [\n    {\n      \"name\": \"<string>\",\n      \"synonyms\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"verified\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://charts.basedash.com/api/public/organizations/{orgId}/models/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"referenceName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"sqlQuery\": \"<string>\",\n  \"measures\": [\n    {\n      \"name\": \"<string>\",\n      \"sql\": \"<string>\",\n      \"description\": \"<string>\",\n      \"synonyms\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"segments\": [\n    {\n      \"name\": \"<string>\",\n      \"sql\": \"<string>\",\n      \"description\": \"<string>\",\n      \"synonyms\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"defaultTimeColumn\": \"<string>\",\n  \"synonyms\": [\n    \"<string>\"\n  ],\n  \"grain\": \"<string>\",\n  \"keyColumns\": [\n    \"<string>\"\n  ],\n  \"relationships\": [\n    {\n      \"targetModelId\": \"<string>\",\n      \"sourceColumn\": \"<string>\",\n      \"targetColumn\": \"<string>\"\n    }\n  ],\n  \"usageGuidance\": \"<string>\",\n  \"columnSynonyms\": [\n    {\n      \"name\": \"<string>\",\n      \"synonyms\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"verified\": true\n}"

response = http.request(request)
puts response.read_body

{
  "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>",
    "verifiedAt": "2023-11-07T05:31:56Z",
    "verifiedByMemberId": "<string>",
    "columns": [
      {
        "name": "<string>",
        "type": "array",
        "nullable": true,
        "example": "<string>",
        "description": "<string>",
        "synonyms": [
          "<string>"
        ],
        "sampleValues": [
          "<string>"
        ]
      }
    ],
    "measures": [
      {
        "name": "<string>",
        "sql": "<string>",
        "description": "<string>",
        "synonyms": []
      }
    ],
    "segments": [
      {
        "name": "<string>",
        "sql": "<string>",
        "description": "<string>",
        "synonyms": []
      }
    ],
    "defaultTimeColumn": "<string>",
    "synonyms": [
      "<string>"
    ],
    "grain": "<string>",
    "keyColumns": [
      "<string>"
    ],
    "relationships": [
      {
        "targetModelId": "<string>",
        "sourceColumn": "<string>",
        "targetColumn": "<string>",
        "cardinality": "many_to_one"
      }
    ],
    "usageGuidance": "<string>",
    "warnings": [
      {
        "code": "base_sql_contains_group_by",
        "message": "<string>",
        "field": "sqlQuery",
        "name": "<string>"
      }
    ]
  }
}

{
  "error": {
    "title": "<string>",
    "detail": "<string>"
  }
}

{
  "error": {
    "title": "<string>",
    "detail": "<string>"
  }
}

{
  "error": {
    "title": "<string>",
    "detail": "<string>"
  }
}

{
  "error": {
    "title": "Conflict",
    "detail": "<string>",
    "referenceName": "<string>",
    "suggestedReferenceName": "<string>"
  }
}

{
  "error": {
    "title": "RateLimitExceeded",
    "detail": "<string>",
    "retryAfterMs": 123
  }
}

{
  "error": {
    "title": "<string>",
    "detail": "<string>"
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

orgId

string

required

Organization ID

string

required

Model ID

Body

application/json

name

string

Human-readable model name

Required string length: 1 - 100

referenceName

string

Stable SQL reference name for the model

Required string length: 1 - 100

description

string

Model description

Maximum string length: 10000

sqlQuery

string

SQL query that defines the reusable dataset

Required string length: 1 - 100000

measures

object[]

Ordered reusable aggregate expressions

Maximum array length: 50

Show child attributes

segments

object[]

Ordered reusable predicate expressions

Maximum array length: 50

Show child attributes

defaultTimeColumn

string | null

Default date result column, or null for no default

Required string length: 1 - 256

synonyms

string[]

Alternative names for the model

Maximum array length: 20

Required string length: 1 - 100

grain

string

What one row in the model represents

Maximum string length: 10000

keyColumns

string[]

Columns that uniquely identify a row

Maximum array length: 10

Required string length: 1 - 256

relationships

object[]

Relationships from this model to other models

Maximum array length: 50

Show child attributes

usageGuidance

string

Guidance about when and how to use the model

Maximum string length: 10000

columnSynonyms

object[]

Alternative names for model result columns

Show child attributes

verified

boolean

Whether the model is verified

Response

Model updated successfully

data

object

required

Show child attributes

Get started

API

Endpoints

Embedding

Recipes

Authorizations

Path Parameters

Body

Response