v7.0

V2
V1
- Account
- Admin
- AdminUpload
- Analysis
- ApiResource
- ApiScope
- Assets
- AuditLog
- Auth
- AuthToken
- Avatar
- BatchDownloadDocuments
- CacheMeta
- Caching
- CheckUpdate
- ClaimMapping
- Client
- Collections
- Config
- CustomizeProperties
- Dashboard
- DashboardView
- DataMonitoring
- DataProvider
- DataSource
- DataSourceAPI
- DataSourceFile
- DataSourcePreview
- Dataset
- DatasetExport
- DatasetPreview
- Design
- DesignApi
- DesignTemplates
- DingTalkAuthentication
- Documents
- EmbededReport
- Export
- ExportTemplate
- ExternalLoginProvider
- ExternalUser
- FloorPlanView
- GraphQl
- Group
- HealthCheck
- Heartbeat
- Hierarchy
- Home
- IdentityResource
- Import
- Integration
- InternalDocuments
- LanguagePackage
- LanguageResource
- License
- LicenseSummarised
- LocalDeployment
- ModelDrafts
- ModelEditor
- Node
- Notification
- Permission
- Pivot
- PluginAssets
- PodIPTest
- Preview
- PushDataset
- QueryEndpoint
- QueueMonitor
- ReferenceResolving
- Reports
- Resource
- Resources
- Role
- RoleDocumentColumns
- SceneView
- Schedule
- ScheduleTemplate
- SchedulesApi
- SecurityProvider
- Semantic
- Session
- Settings
- SharedResources
- StreamingDatasetApi
- SystemConfig
- SystemConfigs
- Tenant
- TenantModification
- Theme
- ThemeFiles
- Token
- Upload
- UploadTheme
- User
- UserFunctions
- View
- VisualSandbox
- WeChat4WorkAuthentication
- WebPages
- WorkerJob
- WorkersRegistrar
- overview

DataSource

[GET] /datasources/create

Response

Status Code: 200

Success

[GET] /datasources/edit/{id}

Parameters

Name	Type	Located In
id	string	query

Response

Status Code: 200

Success

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

Parameters

Name	Type	Located In
filenameRequired	string	path

Response

Status Code: 200

Success

binary

[GET] /api/datasource/edition

Response

Status Code: 200

Success

[POST] /api/datasource/mappingData

Parameters

Name	Type	Located In
edition	string	query

Response

Status Code: 200

Success

any

[GET] /api/datasource/schemas

Response

Status Code: 200

Success

[POST] /api/datasource/tableCollectionSchema

Request Schema

TableSchemaQueryViewModel

Response

Status Code: 200

Success

any

[GET] /api/datasource/tableSchema

Response

Status Code: 200

Success

ColumnViewModel

[POST] /api/datasource/schemas/sqltable

Request Schema

CustomSqlTablesSchemaViewModel

Response

Status Code: 200

Success

[POST] /api/datasource/databases

Request Schema

GetDatabasesRequestModel

Response

Status Code: 200

Success

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

Parameters

Name	Type	Located In
idRequired	string	path

Response

Status Code: 200

Success

binary

[POST] /api/datasource/validateSqlExpression

Request Schema

ValidateSqlExpressionViewModel

Response

Status Code: 200

Success

ColumnViewModel

[POST] /api/datasource/evaluate-expression

Request Schema

ExpressionsViewModel

Response

Status Code: 200

Success

ExpressionsResultViewModel

[POST] /api/datasource/sqlexpressionGroupBy

Parameters

Name	Type	Located In
expression	string	query

Request Schema

DataSourceController+ChechGroupExpressionModel

Response

Status Code: 200

Success

ColumnViewModel

[POST] /api/datasource/sqlexpressionAggregation

Parameters

Name	Type	Located In
expression	string	query

Request Schema

DataSourceController+ChechGroupExpressionModel

Response

Status Code: 200

Success

ColumnViewModel

[POST] /api/datasource/schemadefinition

Request Schema

GetSchemaDefinitionViewModel

Response

Status Code: 200

Success

GetSchemaDefinitionReturnModel

[POST] /api/datasource/preQueryPreview

Request Schema

GetSchemaDefinitionViewModel

Response

Status Code: 200

Success

PreQueryPreviewResult

[GET] /api/datasource/mappingFileTemplate

Parameters

Name	Type	Located In
edition	string	query

Response

Status Code: 200

Success

binary

Models

Ƭ TableSchemaQueryViewModel

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

Ƭ ColumnViewModel

Name	Type	Description	Example
nameNullable	string
aliasNullable	string
dataTypeNullable	string
allowDBNull	Boolean
descriptionNullable	string
isContainTimeZone	Boolean

Ƭ CustomSqlTablesSchemaViewModel

Name	Type	Description	Example
tablesNullable	CustomSqlTableViewModel
parametersNullable	QueryParameterViewModel

Ƭ CustomSqlTableViewModel

Name	Type	Description	Example
datasourceNullable	string
nameNullable	string
queryType	QueryType
sqlCommandNullable	string
procedureSchemaNullable	string
procedureNameNullable	string
procedureParametersNullable	CustomTableProcedureParameterViewModel

Ƭ QueryParameterViewModel

Name	Type	Description	Example
nameNullable	string
parameterTypeNullable	string
parameterValueNullable	string
parameterDefaultValueNullable	string
dataTypeNullable	string
multivalue	Boolean
tableNullable	string

Ƭ QueryType

Enum:

Text
StoredProcedure

Ƭ CustomTableProcedureParameterViewModel

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

Ƭ GetDatabasesRequestModel

Name	Type	Description	Example
providerNullable	string
connectionStringNullable	string

Ƭ ValidateSqlExpressionViewModel

Name	Type	Description	Example
datasourceIdNullable	string
selectedTableNameNullable	string
selectedTableSchemaNullable	string
expressionNullable	string
parametersNullable	QueryParameterViewModel

Ƭ ExpressionsResultViewModel

Name	Type	Description	Example
dataNullable	any
dataTypeNullable	string

Ƭ ExpressionsViewModel

Name	Type	Description	Example
expressionNullable	string

Ƭ DataSourceController+ChechGroupExpressionModel

Name	Type	Description	Example
expressionNullable	string
useCache	Boolean
parametersNullable	QueryParameterViewModel
commandModel	TableJoinQueryViewModel

Ƭ TableJoinQueryViewModel

Name	Type	Description	Example
firstTable	TableViewModel
joinRelationsNullable	JoinRelationViewModel

Ƭ TableViewModel

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

Ƭ JoinRelationViewModel

Name	Type	Description	Example
joinTypeNullable	string
table	TableViewModel
conditionsNullable	JoinConditionViewModel

Ƭ FilterExpression

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

Ƭ FieldViewModel

Name	Type	Description	Example
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	Description	Example
leftColumn	JoinColumnViewModel
operatorNullable	string
rightColumn	JoinColumnViewModel

Ƭ JoinColumnViewModel

Name	Type	Description	Example
columnNameNullable	string
tableNameNullable	string

Ƭ GetSchemaDefinitionReturnModel

Name	Type	Description	Example
columnNamesNullable	`Array<string>`
rowsNullable	`Array<array>`

Ƭ GetSchemaDefinitionViewModel

Name	Type	Description	Example
providerNullable	string
connectionStringNullable	string

Ƭ PreQueryPreviewResult

Name	Type	Description	Example
tablesNullable	PreQueryPreviewResultTable

Ƭ PreQueryPreviewResultTable

Name	Type	Description	Example
tableNameNullable	string
schemaNameNullable	string
columnsNullable	PreQueryPreviewResultColumn
rowsNullable	RowData

Ƭ PreQueryPreviewResultColumn

Name	Type	Description	Example
columnNameNullable	string

Ƭ RowData

Name	Type	Description	Example
dataNullable	`Array`