Dataset

[POST] /api/dataset/data

Request Body

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

DataEndpointQueryModel+DataSet

Responses

[200] Success

binary

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

[POST] /api/datasource/data

Request Body

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

DataEndpointQueryModel+DataSource

Responses

[200] Success

binary

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

[POST] /api/v1/datasource/data

Request Body

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

DataEndpointQueryModel+DataSource

Responses

[200] Success

binary

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

[POST] /api/semantic/data

Request Body

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

DataEndpointQueryModel+Semantic

Responses

[200] Success

binary

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

[POST] /api/semantic/aggregates

Request Body

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

DataEndpointQueryModel+Semantic

Responses

[200] Success

System.Collections.Generic.KeyValuePair`2[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e],[GrapeCity.Enterprise.Data.DataEngine.Aggregates.AggregateFunction, Wyn.ActiveReports.Core.Data.DataEngine, Version=9.0.2.0, Culture=neutral, PublicKeyToken=0b5e1563d2869208]]

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

[GET] /datasets/create

Parameters

Name	In	Type
type	query	string
title	query	string

Responses

[200] Success

[GET] /datasets/edit/{id}

Parameters

Name	In	Type
id	query	string
title	query	string

Responses

[200] Success

[GET] /api/datasetmanagement/getdatasetdetail/{param}

Parameters

Name	In	Type
param	query	string

Responses

[200] Success

DatasetViewModel

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

[GET] /api/datasetmanagement/getData/{param}

Parameters

Name	In	Type
param	query	string
rowLimit	query	integer

Responses

[200] Success

[POST] /api/datasetmanagement/validateDataset

Request Body

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

PreviewDatasetViewModel

Responses

[200] Success

boolean

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

[POST] /api/datasetmanagement/addDataset

Request Body

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

DatasetViewModel

Responses

[200] Success

[PUT] /api/datasetmanagement/updateDataset/{param}

Parameters

Name	In	Type
param	query	string

Request Body

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

DatasetViewModel

Responses

[200] Success

[POST] /api/datasetmanagement/customTablePreview

Request Body

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

PreivewCustomTableViewModel

Responses

[200] Success

[POST] /api/datasetmanagement/tablePreview

Request Body

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

PreviewTableViewModel

Responses

[200] Success

[POST] /api/datasetmanagement/preview

Parameters

Name	In	Type
ignoreusercontext	query	string
rowcount	query	string

Request Body

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

PreviewDatasetViewModel

Responses

[200] Success

[GET] /api/datasetmanagement/customizeProperties

Responses

[200] Success

[GET] /api/datasetmanagement/organizationProperties

Responses

[200] Success

[GET] /api/datasetmanagement/functionDescription

Parameters

Name	In	Type
culture	query	string

Responses

[200] Success

[GET] /api/datasetmanagement/sqlFunctions

Parameters

Name	In	Type
culture	query	string

Responses

[200] Success

[POST] /api/datasetmanagement/refreshCot/{documentId}/{role}

Parameters

Name	In	Type
documentIdRequired	path	string
roleRequired	path	string

Responses

[200] Success

[PUT] /api/datasetmanagement/refreshCot/{param}

Parameters

Name	In	Type
param	query	string
overwrite	query	boolean

Responses

[200] Success

[PUT] /api/datasetmanagement/batchRefreshCot

Parameters

Name	In	Type
overwrite	query	boolean

Request Body

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

BatchRefreshModel

Responses

[200] Success

[POST] /api/dataset/query

Request Body

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

QueryEmbedDatasetModel

Responses

[200] Success

[POST] /api/datasetmanagement/dataModel

Request Body

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

DatasetViewModel

Responses

[200] Success

DataSetDocument

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

[POST] /api/datasetmanagement/viewModel

Request Body

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

DataSetDocument

Responses

[200] Success

DatasetViewModel

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

[GET] /api/datasetmanagement/download/{param}

Parameters

Name	In	Type
param	query	string

Responses

[200] Success

binary

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

[POST] /api/datasetmanagement/sqlValidate/{param}

Parameters

Name	In	Type
param	query	string

Request Body

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

PreviewDatasetViewModel

Responses

[200] Success

[GET] /api/dataset/getcssurl

Parameters

Name	In	Type
cssName	query	string
theme	query	string

Responses

[200] Success

[GET] /api/dataset/getjsasseturlprefix

Responses

[200] Success

[GET] /api/datasetmanagement/licenseinfo

Responses

[200] Success

[POST] /api/datasetmanagement/revert/{datasetId}/{revision}

Parameters

Name	In	Type
datasetIdRequired	path	string
revisionRequired	path	integer

Responses

[200] Success

[GET] /api/models/download/{param}

Parameters

Name	In	Type
param	query	string

Responses

[200] Success

binary

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

[GET] /api/datasetmanagement/cached-datasets

Responses

[200] Success

[GET] /api/datasetmanagement/cots

Responses

[200] Success

[GET] /api/semantic

Responses

[200] Success

[POST] /api/semantic

Request Body

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

SemanticViewModels+CreateSemanticModelRequestModel

Responses

[200] Success

SemanticViewModels+ModelEx

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

[POST] /api/semantic/upload

Request Body

Type: multipart/form-data

Key	Type	Format	Encoding
file	string	binary	form

Responses

[200] Success

[POST] /api/semantic/nameexist

Request Body

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

SemanticViewModels+ValidateNameModel

Responses

[200] Success

boolean

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

[GET] /api/semantic/{documentId}/info

Parameters

Name	In	Type
documentIdRequired	path	string

Responses

[200] Success

SemanticViewModels+ModelEx

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

[GET] /api/semantic/{documentId}/draft

Parameters

Name	In	Type
documentIdRequired	path	string

Responses

[200] Success

SemanticViewModels+ModelEx

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

[GET] /api/semantic/{id}/draft/entities/{entityId}

Parameters

Name	In	Type
idRequired	path	string
entityIdRequired	path	string

Responses

[200] Success

SemanticViewModels+EntityEx

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

[GET] /api/semantic/{documentId}/file

Parameters

Name	In	Type
documentIdRequired	path	string

Responses

[200] Success

binary

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

[GET] /api/semantic/models

Responses

[200] Success

SemanticViewModels+ModelInfo

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

[GET] /api/semantic/{documentId}/entities

Parameters

Name	In	Type
documentIdRequired	path	string

Responses

[200] Success

SemanticViewModels+EntityInfo

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

[GET] /api/semantic/{documentId}/content

Parameters

Name	In	Type
documentIdRequired	path	string

Responses

[200] Success

SemanticViewModels+Model

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

[GET] /api/semantic/{documentId}/title

Parameters

Name	In	Type
documentIdRequired	path	string

Responses

[200] Success

[POST] /api/semantic/{documentId}/scope

Parameters

Name	In	Type
documentIdRequired	path	string

Request Body

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

SemanticViewModels+EntityScopeRequest

Responses

[200] Success

SemanticViewModels+EntityScopeResponse

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

[POST] /api/semantic/revert/{modelId}/{revision}

Parameters

Name	In	Type
modelIdRequired	path	string
revisionRequired	path	integer

Responses

[200] Success

[GET] /api/datasetmanagement/queryDatasetTasks

Responses

[200] Success

WorkerTaskStatus

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

[GET] /api/datasetmanagement/queryDatasourceTaskStatus/{param}

Parameters

Name	In	Type
param	query	string

Responses

[200] Success

WorkerTaskStatus

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

[GET] /api/datasetmanagement/queryDatasetTaskStatus/{param}

Parameters

Name	In	Type
param	query	string

Responses

[200] Success

WorkerTaskStatus

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

[POST] /api/datasetmanagement/batchQueryDatasetTaskStatus

Request Body

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

BatchRefreshModel

Responses

[200] Success

Models

Ƭ DataEndpointQueryModel+DataSet

Name	Type
datasetIdNullable	string
revisionNullable	int32
previewRowsNullable	int32
parametersNullable	Array<DataEndpointQueryModel+DataSet+Parameter>
extraFilters	DataEndpointQueryModel+ExtraFilter

Ƭ DataEndpointQueryModel+DataSet+Parameter

Name	Type
nameNullable	string
valueNullable	string

Ƭ DataEndpointQueryModel+ExtraFilter

Name	Type
conditionType	ConditionType
conditionItemsNullable	Array<DataEndpointQueryModel+ExtraFilter>
fieldNameNullable	string
operatorNullable	string
valueNullable	Array
valueType	DataEndpointQueryModel+ValueType

Ƭ ConditionType

Enum:

• AndGroup
• OrGroup
• Rule

Ƭ DataEndpointQueryModel+ValueType

Enum:

• Constant
• Parameter

Ƭ DataEndpointQueryModel+DataSource

Name	Type
datasourceIdNullable	string
revisionNullable	int32
sqlNullable	string
parametersNullable	Array<DataEndpointQueryModel+DataSource+Parameter>

Ƭ DataEndpointQueryModel+DataSource+Parameter

Name	Type
nameNullable	string
valueNullable	string

Ƭ DataEndpointQueryModel+Semantic

Name	Type
datasourceIdNullable	string
revisionNullable	int32
semanticQueryNullable	string
parametersNullable	Array<DataEndpointQueryModel+Semantic+Parameter>

Ƭ DataEndpointQueryModel+Semantic+Parameter

Name	Type
nameNullable	string
valueNullable	string

Ƭ System.Collections.Generic.KeyValuePair`2[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e],[GrapeCity.Enterprise.Data.DataEngine.Aggregates.AggregateFunction, Wyn.ActiveReports.Core.Data.DataEngine, Version=9.0.2.0, Culture=neutral, PublicKeyToken=0b5e1563d2869208]]

Name	Type
keyNullable	string
value	AggregateFunction

Ƭ AggregateFunction

Enum:

• Empty
• Sum
• Avg
• Max
• Min
• Count
• CountDistinct
• CountRows
• StDev
• StDevP
• Var
• VarP
• First
• Last
• Aggregate
• Median
• Mode
• DistinctSum
• AggregateIf
• ToArray

Ƭ DatasetViewModel

Name	Type
nameNullable	string
query	QueryViewModel
fieldsNullable	Array<FieldViewModel>
groupFieldsNullable	Array<FieldViewModel>
customSqlTablesNullable	Array<CustomSqlTableViewModel>
filterExpressionsNullable	Array<FilterExpression>
filterConditions	FilterCondition
indexed	Boolean
tagIdsNullable	Array<string>
commentNullable	string
incrementalUpdateSetting	IncrementalUpdateFilterViewModel
waxExpressionsNullable	Array<WAXExpressionViewModel>
useTenantBasedCaches	Boolean
enableViews	Boolean
enableSQLView	Boolean
datasetViewsNullable	Array<DatasetViewViewModel>
aiAssistantInfo	AIAssistantInfoViewModel

Ƭ QueryViewModel

Name	Type
dataSourcesNullable	Array<DataSourceViewModel>
parametersNullable	Array<QueryParameterViewModel>
commandTextNullable	string
commandTypeNullable	string
commandModel	TableJoinQueryViewModel

Ƭ 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

Ƭ CustomSqlTableViewModel

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

Ƭ FilterExpression

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

Ƭ FilterCondition

Name	Type
conditionType	ConditionType
conditionItemsNullable	Array<FilterCondition>
typeNullable	string
tableNullable	string
columnNullable	string
expressionNullable	string
operatorNullable	string
valueNullable	Array
valueTypeNullable	string
targetTypeNullable	string
multivalue	Boolean

Ƭ IncrementalUpdateFilterViewModel

Name	Type
tableNullable	string
fieldNullable	string
aliasNullable	string

Ƭ WAXExpressionViewModel

Name	Type	Description
nameNullable	string	Field Name
logicalDataTypeNullable	string	Logical type of expression evaluation result
expressionNullable	string	Expression body
fieldTypeNullable	string	Type of the expression, measure or calculated column

Ƭ DatasetViewViewModel

Name	Type
viewIdNullable	string
viewNameNullable	string
priority	int32
fieldsNullable	Array<MaskedFieldViewModel>
condition	DatasetViewConditionViewModel

Ƭ AIAssistantInfoViewModel

The AIAssistantInfo class represents the AI assistant configuration for a dataset.

Name	Type	Description
enabled	Boolean	value indicating whether the dataset can be used in chat analysis.
descriptionNullable	string	The summary information of the dataset that will be used for AI to automatically retrieve the dataset
columnAssistantInfosNullable	Array<ColumnAssistantInfoViewModel>	The list of column assistant information, which contains the column name and its description.

Ƭ DataSourceViewModel

Name	Type
idNullable	string
nameNullable	string
fileNameNullable	string
providerNullable	string
useAdvancedConfig	Boolean
connectionStringNullable	string
mappingConfigsNullable	Array<TableMappingInfo>
useUserContext	Boolean
useMultiTenant	Boolean
isExtracted	Boolean
supportNativeQuery	Boolean
supportDirectQuery	Boolean
isCustomNativeQueryProvider	Boolean
typeNullable	string
editorConfigNullable	string

Ƭ QueryParameterViewModel

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

Ƭ TableJoinQueryViewModel

Name	Type
firstTable	TableViewModel
joinRelationsNullable	Array<JoinRelationViewModel>

Ƭ TableMappingInfo

Name	Type
tableOriginalNameNullable	string
tableDisplayNameNullable	string
columnsNullable	Array<ColumnMappingInfo>

Ƭ ColumnMappingInfo

Name	Type
columnOriginalNameNullable	string
columnDisplayNameNullable	string

Ƭ 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>

Ƭ JoinConditionViewModel

Name	Type
leftColumn	JoinColumnViewModel
operatorNullable	string
rightColumn	JoinColumnViewModel

Ƭ JoinColumnViewModel

Name	Type
columnNameNullable	string
tableNameNullable	string

Ƭ QueryType

Enum:

• Text
• StoredProcedure

Ƭ CustomTableProcedureParameterViewModel

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

Ƭ MaskedFieldViewModel

Name	Type	Description
fieldNameNullable	string	Field Name
descriptionNullable	string	Field Description
dataTypeNullable	string	DataType
fieldStatus	FieldStatus
redactedValueNullable	any	RedactedValue

Ƭ DatasetViewConditionViewModel

Name	Type	Description
conditionType	DatasetViewConditionType
itemsNullable	Array<DatasetViewConditionViewModel>	Condition Items
filterKeyNullable	string	Filter Key
filterValueNullable	any	Filter Value
filterDataTypeNullable	string	Filter Data Type
filterType	DatasetViewFilterType
operator	DatasetViewConditionOperator
indexNullable	string	Filter index

Ƭ FieldStatus

Enum:

• Visible
• Hidden
• Redacted

Ƭ DatasetViewConditionType

Enum:

• AndGroup
• OrGroup
• Rule

Ƭ DatasetViewFilterType

Enum:

• UserContext
• OrganizationContext
• Role

Ƭ DatasetViewConditionOperator

Enum:

• Equal
• NotEqual
• In
• NotIn
• Contains
• NotContains

Ƭ ColumnAssistantInfoViewModel

Represents information about a dataset column(field), including its name and description.

Name	Type	Description
columnNameNullable	string	Column(Field) Name
descriptionNullable	string	The summary information of the dataset fields that will be used for AI to automatically retrieve the dataset and relative columns.

Ƭ PreviewDatasetViewModel

Name	Type
dataSetDoc	DatasetViewModel
parametersNullable	Array<DatasetParameterValue>

Ƭ DatasetParameterValue

Name	Type
nameNullable	string
valueNullable	Array
multivalue	Boolean

Ƭ PreivewCustomTableViewModel

Name	Type
tableNameNullable	string
connectIdNullable	string
queryType	QueryType
sqlCommandNullable	string
sqlExecuteCommandNullable	string
querySchemaNullable	string
rowLimit	int32
parametersNullable	string
parameterValuesNullable	Array<DatasetParameterValue>
dataSourceParametersNullable	Array<DataSourceParameter>
procedureSchemaNullable	string
procedureNameNullable	string
procedureParametersNullable	Array<CustomTableProcedureParameterViewModel>
connectionStringNullable	string
providerNameNullable	string

Ƭ DataSourceParameter

Name	Type
nameNullable	string
valueNullable	string
dataTypeNullable	string
isMultivalued	Boolean
delimiterNullable	string
tableNameNullable	string

Ƭ PreviewTableViewModel

Name	Type
datasourceIdNullable	string
schemaNameNullable	string
tableNameNullable	string
rowLimit	int32
dataSourceParametersNullable	Array<DataSourceParameter>

Ƭ BatchRefreshModel

Name	Type
refreshDataSetIdsNullable	Array<string>
cotSearchEntryInfosNullable	Array<SearchEntryInfo>

Ƭ SearchEntryInfo

Name	Type
tenantIdNullable	string
datasetIdNullable	string

Ƭ QueryEmbedDatasetModel

Name	Type
dataset	DataSetDocument
parametersNullable	Array<DatasetParameterValue>

Ƭ DataSetDocument

Name	Type
nameNullable	string
query	DataSetQuery
fieldsNullable	Array<DataSetField>
groupFieldsNullable	Array<DataSetField>
filtersNullable	Array<DataSetFilter>
filterConditions	DataSetFilterTree
customSqlTablesNullable	Array<DataSetCustomTable>
indexed	Boolean
incrementalUpdateSettings	IncrementalUpdateSettings
enableViews	Boolean
enableSQLView	Boolean
datasetViewsNullable	Array<DatasetView>
waxExpressionsNullable	Array<WAXExpression>
useTenantBasedCaches	Boolean
aiAssistantInfo	AIAssistantInfo

Ƭ DataSetQuery

Name	Type
dataSourcesNullable	Array<DataSetQuerySource>
queryParametersNullable	Array<DataSetQueryParameter>
commandTextNullable	string
sqlParametersNullable	Array<DataSetQueryValue>
commandType	CommandType
commandModel	TableJoinQuery

Ƭ DataSetField

Name	Type
nameNullable	string
dataFieldNullable	string
typeNameNullable	string
tableNameNullable	string
descriptionNullable	string
fieldTypeNullable	string
dataVizAIHint	DataVizAIHint
formatNullable	string
aggregationNullable	string
rawTypeNullable	string
msDescriptionNullable	string
clrTypeNullable	string
isContainTimeZoneNullable	Boolean

Ƭ DataSetFilter

Name	Type
filterExpressionNullable	string
operatorNullable	string
filterValueDataTypeNullable	string
filterValue	FilterValue
tableNullable	string
columnNullable	string
filterType	FilterType
multivalue	Boolean

Ƭ DataSetFilterTree

Name	Type
conditionType	ConditionType
conditionItemsNullable	Array<DataSetFilterTree>
filterExpressionNullable	string
operatorNullable	string
filterValueDataTypeNullable	string
filterValue	FilterValue
tableNullable	string
columnNullable	string
filterType	FilterType
multivalue	Boolean

Ƭ DataSetCustomTable

Name	Type
customNameNullable	string
dataSourceIdNullable	string
sqlCommandNullable	string
sqlExecuteCommandNullable	string
querySchemaNullable	string
queryType	QueryType
procedureSchemaNullable	string
procedureNameNullable	string
procedureParameters	CustomTableProcedureParameterCollection

Ƭ IncrementalUpdateSettings

Name	Type
filtersNullable	Array<IncrementalUpdateFilter>
orderListNullable	Array<OrderInfo>

Ƭ DatasetView

Name	Type
viewIdNullable	string
viewNameNullable	string
priority	int32
fieldsNullable	Array<MaskedField>
condition	DatasetViewCondition

Ƭ WAXExpression

Name	Type
nameNullable	string
dataTypeNullable	string
expressionNullable	string
expressionType	WAXExpressionType

Ƭ AIAssistantInfo

Name	Type
enabled	Boolean
descriptionNullable	string
columnAssistantInfosNullable	Array<ColumnAssistantInfo>

Ƭ DataSetQuerySource

Name	Type
nameNullable	string
idNullable	string
type	DataSetQuerySourceType
connectionStringNullable	string
providerNullable	string

Ƭ DataSetQueryParameter

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

Ƭ DataSetQueryValue

Name	Type
parameterIdentifierNullable	string
parameterNameNullable	string
valueNullable	any
targetTypeNullable	string

Ƭ CommandType

Enum:

• Sql
• Model

Ƭ TableJoinQuery

Name	Type
firstTable	TableQuery
joinRelationsNullable	Array<JoinQuery>

Ƭ DataSetQuerySourceType

Enum:

• DataSource
• CachedDataset
• DirectDataset
• Etl
• DataFlow

Ƭ TableQuery

Name	Type
idNullable	string
tableType	TableType
tableNameNullable	string
sqlNullable	string
querySchemaNullable	string
dataSourceIdNullable	string
unionType	UnionType
unionMapNullable	Array<object>
filtersNullable	Array<DataSetFilter>
sQlExpressionsNullable	Array<DataSetField>
tablesNullable	Array<TableQuery>
parametersNullable	Array<DataSetQueryValue>

Ƭ JoinQuery

Name	Type
joinTypeNullable	string
leftTable	TableQuery
rightTable	TableQuery
conditionsNullable	Array<JoinCondition>

Ƭ TableType

Enum:

• NativeTable
• UnionTable
• CustomSqlTable
• ReferencedDataset

Ƭ UnionType

Enum:

• None
• Union
• UnionAll

Ƭ FilterValue

Name	Type
firstNullable	any
secondNullable	any
targetTypeNullable	string

Ƭ FilterType

Enum:

• Table
• Dataset
• Datasource

Ƭ DataVizAIHint

Enum:

• None
• Currency
• ImageURL
• ImageBinary
• GeoRegion
• GeoLatitude
• GeoLongitude
• GeoCountry
• GeoProvince
• GeoCity
• GeoDistrict

Ƭ JoinCondition

Name	Type
leftColumn	ColumnIdentity
operatorNullable	string
rightColumn	ColumnIdentity

Ƭ ColumnIdentity

Name	Type
tableNameNullable	string
columnNameNullable	string

Ƭ CustomTableProcedureParameterCollection

Name	Type
parametersNullable	Array<CustomTableProcedureParameter>

Ƭ CustomTableProcedureParameter

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

Ƭ IncrementalUpdateFilter

Name	Type
filterType	FilterType
operatorNullable	string
tableNullable	string
fieldNullable	string
nameNullable	string

Ƭ OrderInfo

Name	Type
nameNullable	string
orderNullable	string

Ƭ MaskedField

Name	Type
fieldNameNullable	string
dataTypeNullable	string
descriptionNullable	string
fieldStatus	FieldStatus
redactedValueNullable	any

Ƭ DatasetViewCondition

Name	Type
conditionType	DatasetViewConditionType
itemsNullable	Array<DatasetViewCondition>
filterKeyNullable	string
filterValueNullable	any
filterDataTypeNullable	string
filterType	DatasetViewFilterType
operator	DatasetViewConditionOperator
indexNullable	string

Ƭ WAXExpressionType

Enum:

• Measure
• CalculatedColumn

Ƭ ColumnAssistantInfo

Name	Type
columnNameNullable	string
descriptionNullable	string

Ƭ SemanticViewModels+ModelEx

Represent a semantic model.

Name	Type	Description
idNullable	string	Get or set semantic model id.
nameNullable	string	Get or set semantic model name.
providerNullable	string	Get or set semantic model data source provider.
connectionStringNullable	string	Get or set semantic model data source connection srting.
commandTimeoutNullable	int32	Get or set semantic model data source command timeout.
entitiesNullable	Array<SemanticViewModels+EntityEx>	Get or set semantic model entities.
displayNameNullable	string	Semantic model translate title

Ƭ SemanticViewModels+EntityEx

Semantic model entity.

Name	Type	Description
attributesNullable	Array<AttributeContract>	Entity attributes.
relationsNullable	Array<RelationContract>	Entity relations.
parametersNullable	Array<SemanticViewModels+Parameter>	Entity parameters.
id	string	Entity id.
nameNullable	string	Entity name.
descriptionNullable	string	Entity description.
procedureBindingNullable	string	Entity procedure binding.
bindingNullable	string	Entity binding.
collectionNameNullable	string	Entity collection name.
queryNullable	string	Entity query.
hidden	Boolean	Entity is hidden.
collapseInRelations	Boolean	Entity is collape in relations.
securityFilter	SecurityFilterContract
defaultAggregateAttributesNullable	Array<SemanticViewModels+SimpleAttributeContract>	Entity default aggregate attributes.
defaultDetailAttributesNullable	Array<SemanticViewModels+SimpleAttributeContract>	Entity default detail attributes.
identifyingAttributesNullable	Array<SemanticViewModels+SimpleAttributeContract>	Entity identifying attributes.

Ƭ AttributeContract

Represent attribute contract.

Name	Type	Description
id	string	Attribute id.
bindingNullable	string	Attribute binding.
dataType	DataType
logicalDataType	LogicalDataType
formatNullable	string	Attribute format.
discourageGrouping	Boolean	Attribute discourage grouping.
hidden	Boolean	Attribute hidden.
isAggregate	Boolean	Attribute isAggregate.
nullable	Boolean	Attribute is nullable.
supportsBlank	Boolean	Attribute is supports blank.
supportsNull	Boolean	Attribute is supports null.
valueSelection	ValueSelection
variationOfNullable	string	Attribute variation of.
expressionNullable	string	Attribute expression.
variationsNullable	Array<AttributeContract>	Attribute variations.
expressionTextNullable	string	Attribute expression text.
nameNullable	string
descriptionNullable	string

Ƭ RelationContract

Represent realtion contract.

Name	Type	Description
id	string	Relation id.
bindingNullable	string	Relation binding.
cardinality	Cardinality
isLogical	Boolean	Relation is logical.
hidden	Boolean	Relation is hidden.
recursive	Boolean	Relation is recursive
includeSelf	Boolean	Relation is included by self.
hiddenFieldsNullable	Array<string>	Relation hidden fields.
sourceEntityId	string	Relation source entity id.
sourceColumnsNullable	Array<string>	Relation source columns.
targetEntityId	string	Relation target entity id.
targetColumnsNullable	Array<string>	Relation taeget columns.
nameNullable	string
descriptionNullable	string

Ƭ SemanticViewModels+Parameter

Name	Type
idNullable	string
nameNullable	string
dataTypeNullable	string
valueNullable	string
defaultValueNullable	string
validValuesNullable	Array<SemanticViewModels+_ParameterValue>
allowNullNullable	Boolean
promptNullable	string

Ƭ SecurityFilterContract

Name	Type
id	string
filterNameNullable	string
existingFilterPathNullable	string
attributePathNullable	string
expressionNullable	string
operationNullable	string

Ƭ SemanticViewModels+SimpleAttributeContract

Name	Type
idNullable	string
pathNullable	string
nameNullable	string
entityIdNullable	string
hidden	Boolean

Ƭ DataType

Enum:

• Null
• DateTime
• Float
• Decimal
• Integer
• Boolean
• String
• Binary
• All
• EntityKey

Ƭ LogicalDataType

Enum:

• Null
• DateTime
• Date

Ƭ ValueSelection

Enum:

• None
• Dropdown
• List

Ƭ Cardinality

Enum:

• One
• Many
• OptionalOne
• OptionalMany

Ƭ SemanticViewModels+_ParameterValue

Name	Type
labelNullable	string
valueNullable	string

Ƭ SemanticViewModels+CreateSemanticModelRequestModel

Name	Type
nameNullable	string
providerNullable	string
connectionStringNullable	string
tablesNullable	Array<string>
findRelations	Boolean
commandTimeoutNullable	string

Ƭ SemanticViewModels+ValidateNameModel

Represent semantic model name validatation model.

Name	Type	Description
idNullable	string	Get or set semantic model id.
nameRequired	string	Get or set semantic model name.

Ƭ SemanticViewModels+ModelInfo

Represent a semantic model info model.

Name	Type	Description
idNullable	string	Get or set model info id.
titleNullable	string	Get or set model name.
effective_ops	Operations
revisionNo	int32	Get or set model revision no.
modelIdNullable	string	Get or set model id.
modelVersionNullable	string	Get or set model version.

Ƭ Operations

Enum:

• None
• Create
• Read
• Update
• Delete
• Modify
• ChangePermission
• Execute
• FullControl
• All

Ƭ SemanticViewModels+EntityInfo

Represent a semantic model entity info model.

Name	Type	Description
idNullable	string	Get or set entity id.
nameNullable	string	Get or set entity name.
hidden	Boolean	Get or set entity hidden status.

Ƭ SemanticViewModels+Model

Represent semantic model content model.

Name	Type	Description
entitiesNullable	Array<SemanticViewModels+Entity>	Get or set semantic model entities.

Ƭ SemanticViewModels+Entity

Represent semantic model content entity model.

Name	Type	Description
idNullable	string	Get or set semantic model entity id.
nameNullable	string	Get or set semantic model entity idname
hidden	Boolean	Get or set semantic model entity hidden status.
attributesNullable	Array<SemanticViewModels+Attribute>	Get or set semantic model entity attributes.
relationsNullable	Array<SemanticViewModels+Relation>	Get or set semantic model entity relations.
parametersNullable	Array<SemanticViewModels+ParameterForReport>	Get or set semantic model entity parameters.
defaultAggregateAttributesIdsNullable	Array<string>	Get or set semantic model entity default aggregate attributes ids.
defaultDetailAttributesIdsNullable	Array<string>	Get or set semantic model entity default detail attributes ids.
identifyingAttributesIdsNullable	Array<string>	Get or set semantic model entity identifying attributes ids.
descriptionNullable	string	Get or set semantic model entity description.

Ƭ SemanticViewModels+Attribute

Name	Type
idNullable	string
nameNullable	string
hidden	Boolean
dataTypeNullable	string
logicalDataTypeNullable	string
formatNullable	string
isAggregate	Boolean
discourageGrouping	Boolean
variationsNullable	Array<SemanticViewModels+Attribute>
descriptionNullable	string

Ƭ SemanticViewModels+Relation

Name	Type
idNullable	string
nameNullable	string
hidden	Boolean
cardinalityNullable	string
relatedEntityIdNullable	string
hiddenFieldsNullable	Array<string>
descriptionNullable	string

Ƭ SemanticViewModels+ParameterForReport

Name	Type
idNullable	string
isSpecial	Boolean
nameNullable	string
dataTypeNullable	string
valueNullable	string
defaultValue	EntityProcedureUiParameterValue
validValuesDomain	EntityProcedureUiParameterValidValuesDomain
validValuesNullable	Array<EntityProcedureUiParameterValue>
attributeReference	EntityProcedureUiAtributeReference
allowNullNullable	Boolean
promptNullable	string

Ƭ EntityProcedureUiParameterValue

Represent entity procedure UI parameter value.

Name	Type	Description
valueNullable	string	Entity procedure UI prameter value.
labelNullable	string	Entity procedure UI prameter label.
isSpecial	Boolean	Entity procedure UI prameter is special.

Ƭ EntityProcedureUiParameterValidValuesDomain

Enum:

• AnyValue

• FromTheDatabase

• FromAList

  Represent entity procedure UI parameter valid values domain.

Ƭ EntityProcedureUiAtributeReference

Represent entity procedure UI attribute reference.

Name	Type	Description
nameNullable	string	Attribute name.
pathNullable	string	Attribute path.
valuesNullable	Array<EntityProcedureUiParameterValue>	Entity procedure UI attribute reference values.

Ƭ SemanticViewModels+EntityScopeResponse

Represent a semantic model entities scope response model.

Name	Type	Description
entitiesNullable	Array<SemanticViewModels+Entity>	Get or set an entity list.
errorsNullable	Array<string>	Get or set an error list.
scopesLoadedNullable	Array<string>	Get or set entity scope load list.

Ƭ SemanticViewModels+EntityScopeRequest

Represent a semantic model entities scope request model.

Name	Type	Description
scopesNullable	Array<SemanticViewModels+EntityScope>	Get or set an entity scope list.
excludedIdsNullable	Array<string>	Get or set an excluded entity id list.

Ƭ SemanticViewModels+EntityScope

Name	Type
baseEntityNameNullable	string
attributePathsNullable	Array<string>
byIdNullable	Boolean
withRelationsNullable	Boolean

Ƭ WorkerTaskStatus

Name	Type
taskIdNullable	string
status	WorkerTaskStatusEnum
statusTextNullable	string
startTimeNullable	ISO DateTime Sting
endTimeNullable	ISO DateTime Sting
errorMessageNullable	string
errorMessageKeyNullable	string
contextNullable	string
extraInfoNullable	string

Ƭ WorkerTaskStatusEnum

Enum:

• Standby
• Running
• PrimaryTaskFinished
• PrimaryTaskFaulted
• PrimaryTaskUserCancelled
• Finished