DataSource

[GET] /datasources/create

Parameters

Name	In	Type
title	query	string

Responses

[200] Success

[GET] /api/datasource/provider/{provider}/userguide

Parameters

Name	In	Type
providerRequired	path	string

Responses

[200] Success

[GET] /datasources/edit/{id}

Parameters

Name	In	Type
id	query	string
title	query	string

Responses

[200] Success

[GET] /api/datasource/image/{filename}

Parameters

Name	In	Type
filenameRequired	path	string

Responses

[200] Success

binary

Type: [text/plain], [application/json], [text/json]

[GET] /api/datasource/edition

Responses

[200] Success

[POST] /api/datasource/mappingData

Parameters

Name	In	Type
edition	query	string

Request Body

Type: multipart/form-data

Key	Type	Format	Encoding
file	array		form

Responses

[200] Success

any

Type: [text/plain], [application/json], [text/json]

[GET] /api/datasource/schemas

Parameters

Name	In	Type
ids	query	string

Responses

[200] Success

[POST] /api/datasource/tableCollectionSchema

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

TableSchemaQueryViewModel

Responses

[200] Success

any

Type: [text/plain], [application/json], [text/json]

[GET] /api/datasource/tableSchema

Parameters

Name	In	Type
datasourceId	query	string
type	query	string
schema	query	string
tableName	query	string
version	query	string

Responses

[200] Success

ColumnViewModel

Type: [text/plain], [application/json], [text/json]

[POST] /api/datasource/schemas/sqltable

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

CustomSqlTablesSchemaViewModel

Responses

[200] Success

[POST] /api/datasource/databases

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

GetDatabasesRequestModel

Responses

[200] Success

[GET] /api/datasource/download/{id}

Parameters

Name	In	Type
idRequired	path	string

Responses

[200] Success

binary

Type: [text/plain], [application/json], [text/json]

[POST] /api/datasource/validateSqlExpression

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

ValidateSqlExpressionViewModel

Responses

[200] Success

ColumnViewModel

Type: [text/plain], [application/json], [text/json]

[POST] /api/datasource/evaluate-expression

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

ExpressionsViewModel

Responses

[200] Success

ExpressionsResultViewModel

Type: [text/plain], [application/json], [text/json]

[POST] /api/datasource/sqlexpressionGroupBy

Parameters

Name	In	Type
expression	query	string

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

DataSourceController+ChechGroupExpressionModel

Responses

[200] Success

ColumnViewModel

Type: [text/plain], [application/json], [text/json]

[POST] /api/datasource/sqlexpressionAggregation

Parameters

Name	In	Type
expression	query	string

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

DataSourceController+ChechGroupExpressionModel

Responses

[200] Success

ColumnViewModel

Type: [text/plain], [application/json], [text/json]

[POST] /api/datasource/schemadefinition

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

GetSchemaDefinitionViewModel

Responses

[200] Success

GetSchemaDefinitionReturnModel

Type: [text/plain], [application/json], [text/json]

[POST] /api/datasource/preQueryPreview

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

GetSchemaDefinitionViewModel

Responses

[200] Success

PreQueryPreviewResult

Type: [text/plain], [application/json], [text/json]

[GET] /api/datasource/mappingFileTemplate

Parameters

Name	In	Type
edition	query	string

Responses

[200] Success

binary

Type: [text/plain], [application/json], [text/json]

Models

Ƭ TableSchemaQueryViewModel

Name	Type
dataSourceIdNullable	string
schemaNullable	string
tableNameNullable	string
typeNullable	string
fullNameNullable	string

Ƭ ColumnViewModel

Name	Type
nameNullable	string
aliasNullable	string
dataTypeNullable	string
allowDBNull	Boolean
descriptionNullable	string
isContainTimeZone	Boolean
clrTypeNullable	string

Ƭ CustomSqlTablesSchemaViewModel

Name	Type
tablesNullable	Array<CustomSqlTableViewModel>
parametersNullable	Array<QueryParameterViewModel>

Ƭ CustomSqlTableViewModel

Name	Type
datasourceNullable	string
nameNullable	string
queryType	QueryType
sqlCommandNullable	string
sqlExecuteCommandNullable	string
querySchemaNullable	string
procedureSchemaNullable	string
procedureNameNullable	string
procedureParametersNullable	Array<CustomTableProcedureParameterViewModel>

Ƭ QueryParameterViewModel

Name	Type
nameNullable	string
parameterTypeNullable	string
parameterValueNullable	string
parameterDefaultValueNullable	string
dataTypeNullable	string
multivalue	Boolean
tableNullable	string
isHiddenNullable	Boolean

Ƭ QueryType

Enum:

• Text
• StoredProcedure

Ƭ CustomTableProcedureParameterViewModel

Name	Type
parameterNameNullable	string
parameterTypeNullable	string
parameterModeNullable	string
parameterPositionNullable	string
parameterDefaultValueNullable	string
parameterValueTypeNullable	string
isOutResultSet	Boolean

Ƭ GetDatabasesRequestModel

Name	Type
providerNullable	string
connectionStringNullable	string

Ƭ ValidateSqlExpressionViewModel

Name	Type
datasourceIdNullable	string
selectedTableNameNullable	string
selectedTableSchemaNullable	string
expressionNullable	string
parametersNullable	Array<QueryParameterViewModel>

Ƭ ExpressionsResultViewModel

Name	Type
dataNullable	any
dataTypeNullable	string

Ƭ ExpressionsViewModel

Name	Type
expressionNullable	string

Ƭ DataSourceController+ChechGroupExpressionModel

Name	Type
expressionNullable	string
useCache	Boolean
parametersNullable	Array<QueryParameterViewModel>
commandModel	TableJoinQueryViewModel

Ƭ TableJoinQueryViewModel

Name	Type
firstTable	TableViewModel
joinRelationsNullable	Array<JoinRelationViewModel>

Ƭ TableViewModel

Name	Type
idNullable	string
tableTypeNullable	string
tableNameNullable	string
sqlNullable	string
querySchemaNullable	string
dataSourceIdNullable	string
unionTypeNullable	string
unionMapNullable	Array<object>
filtersNullable	Array<FilterExpression>
sQlExpressionsNullable	Array<FieldViewModel>
tablesNullable	Array<TableViewModel>

Ƭ JoinRelationViewModel

Name	Type
joinTypeNullable	string
table	TableViewModel
relationTable	TableViewModel
conditionsNullable	Array<JoinConditionViewModel>

Ƭ FilterExpression

Name	Type
typeNullable	string
tableNullable	string
columnNullable	string
expressionNullable	string
operatorNullable	string
valueNullable	Array
valueTypeNullable	string
targetTypeNullable	string
multivalue	Boolean

Ƭ FieldViewModel

Name	Type
tableNullable	string
columnNullable	string
aliasNullable	string
descriptionNullable	string
dataTypeNullable	string
dataVizAIHintNullable	string
formatNullable	string
fieldTypeNullable	string
aggregationNullable	string
rawTypeNullable	string
msDescriptionNullable	string
clrTypeNullable	string
isContainTimeZoneNullable	Boolean

Ƭ JoinConditionViewModel

Name	Type
leftColumn	JoinColumnViewModel
operatorNullable	string
rightColumn	JoinColumnViewModel

Ƭ JoinColumnViewModel

Name	Type
columnNameNullable	string
tableNameNullable	string

Ƭ GetSchemaDefinitionReturnModel

Name	Type
columnNamesNullable	Array<string>
rowsNullable	Array<array>

Ƭ GetSchemaDefinitionViewModel

Name	Type
providerNullable	string
connectionStringNullable	string

Ƭ PreQueryPreviewResult

Name	Type
tablesNullable	Array<PreQueryPreviewResultTable>

Ƭ PreQueryPreviewResultTable

Name	Type
tableNameNullable	string
schemaNameNullable	string
columnsNullable	Array<PreQueryPreviewResultColumn>
rowsNullable	Array<RowData>

Ƭ PreQueryPreviewResultColumn

Name	Type
columnNameNullable	string

Ƭ RowData

Name	Type
dataNullable	Array