Wizard
Profile tables and generate entity YAML
Profiles selected tables from a connected datasource and generates entity YAML definitions with dimensions, measures, joins, query patterns, and heuristic flags. Requires admin role.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:3001/api/v1/wizard/generate" \ -H "Content-Type: application/json" \ -d '{ "connectionId": "string", "tables": [ "string" ] }'{
"connectionId": "string",
"dbType": "string",
"schema": "string",
"entities": [
{
"tableName": "string",
"objectType": "table",
"rowCount": 0,
"columnCount": 0,
"yaml": "string",
"profile": {
"columns": [
{
"name": "string",
"type": "string",
"mappedType": "string",
"nullable": true,
"isPrimaryKey": true,
"isForeignKey": true,
"isEnumLike": true,
"sampleValues": [
"string"
],
"uniqueCount": 0,
"nullCount": 0
}
],
"primaryKeys": [
"string"
],
"foreignKeys": [
{
"fromColumn": "string",
"toTable": "string",
"toColumn": "string",
"source": "constraint"
}
],
"inferredForeignKeys": [
{
"fromColumn": "string",
"toTable": "string",
"toColumn": "string"
}
],
"flags": {
"possiblyAbandoned": true,
"possiblyDenormalized": true
},
"notes": [
"string"
]
}
}
],
"errors": [
{
"table": "string",
"error": "string"
}
]
}{
"error": "string",
"message": "string",
"requestId": "string"
}{
"property1": null,
"property2": null
}{
"property1": null,
"property2": null
}{
"error": "string",
"message": "string",
"requestId": "string"
}{
"property1": null,
"property2": null
}{
"error": "string",
"message": "string",
"requestId": "string"
}