- 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
- DocumentBinder
- Documents
- EmbededReport
- Export
- ExportTemplate
- ExternalLoginProvider
- ExternalUser
- FloorPlanView
- GraphQl
- Group
- HealthCheck
- Heartbeat
- Hierarchy
- Home
- IdentityResource
- Import
- Integration
- InternalDocuments
- LanguagePackage
- LanguageResource
- LocalDeployment
- ModelDrafts
- ModelEditor
- Node
- Notification
- Permission
- Pivot
- PluginAssets
- 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
- WebPages
- WorkerJob
- WorkersRegistrar
- overview
Dataset
Dataset
[GET] /api/datasetmanagement/queryDatasetTasks
Response
Status Code: 200
Success
[GET] /api/datasetmanagement/queryDatasourceTaskStatus/{param}
Parameters
Name | Type | Located In |
---|---|---|
param | string | query |
Response
Status Code: 200
Success
[GET] /api/datasetmanagement/queryDatasetTaskStatus/{param}
Parameters
Name | Type | Located In |
---|---|---|
param | string | query |
Response
Status Code: 200
Success
[POST] /api/datasetmanagement/batchQueryDatasetTaskStatus
Request Schema
Response
Status Code: 200
Success
[POST] /api/dataset/data
Request Schema
DataEndpointQueryModel+DataSet
Response
Status Code: 200
Success
binary
[POST] /api/datasource/data
Request Schema
DataEndpointQueryModel+DataSource
Response
Status Code: 200
Success
binary
[POST] /api/v1/datasource/data
Request Schema
DataEndpointQueryModel+DataSource
Response
Status Code: 200
Success
binary
[POST] /api/semantic/data
Request Schema
DataEndpointQueryModel+Semantic
Response
Status Code: 200
Success
binary
[POST] /api/semantic/aggregates
Request Schema
DataEndpointQueryModel+Semantic
Response
Status Code: 200
Success
[GET] /datasets/create
Parameters
Name | Type | Located In |
---|---|---|
type | string | query |
Response
Status Code: 200
Success
[GET] /datasets/edit/{id}
Parameters
Name | Type | Located In |
---|---|---|
id | string | query |
Response
Status Code: 200
Success
[GET] /api/datasetmanagement/getdatasetdetail/{param}
Parameters
Name | Type | Located In |
---|---|---|
param | string | query |
Response
Status Code: 200
Success
[GET] /api/datasetmanagement/getData/{param}
Parameters
Name | Type | Located In |
---|---|---|
param | string | query |
rowLimit | int32 | query |
Response
Status Code: 200
Success
[POST] /api/datasetmanagement/validateDataset
Request Schema
Response
Status Code: 200
Success
boolean
[POST] /api/datasetmanagement/addDataset
Request Schema
Response
Status Code: 200
Success
[PUT] /api/datasetmanagement/updateDataset/{param}
Parameters
Name | Type | Located In |
---|---|---|
param | string | query |
Request Schema
Response
Status Code: 200
Success
[POST] /api/datasetmanagement/customTablePreview
Request Schema
Response
Status Code: 200
Success
[POST] /api/datasetmanagement/tablePreview
Request Schema
Response
Status Code: 200
Success
[POST] /api/datasetmanagement/preview
Parameters
Name | Type | Located In |
---|---|---|
ignoreusercontext | string | query |
rowcount | string | query |
Request Schema
Response
Status Code: 200
Success
[GET] /api/datasetmanagement/customizeProperties
Response
Status Code: 200
Success
[GET] /api/datasetmanagement/organizationProperties
Response
Status Code: 200
Success
[GET] /api/datasetmanagement/functionDescription
Parameters
Name | Type | Located In |
---|---|---|
culture | string | query |
Response
Status Code: 200
Success
[GET] /api/datasetmanagement/sqlFunctions
Parameters
Name | Type | Located In |
---|---|---|
culture | string | query |
Response
Status Code: 200
Success
[POST] /api/datasetmanagement/refreshCot/{documentId}/{role}
Parameters
Name | Type | Located In |
---|---|---|
documentIdRequired | string | path |
roleRequired | string | path |
Response
Status Code: 200
Success
[PUT] /api/datasetmanagement/refreshCot/{param}
Parameters
Name | Type | Located In |
---|---|---|
param | string | query |
overwrite | Boolean | query |
Response
Status Code: 200
Success
[PUT] /api/datasetmanagement/batchRefreshCot
Parameters
Name | Type | Located In |
---|---|---|
overwrite | Boolean | query |
Request Schema
Response
Status Code: 200
Success
[POST] /api/dataset/query
Request Schema
Response
Status Code: 200
Success
[POST] /api/datasetmanagement/dataModel
Request Schema
Response
Status Code: 200
Success
[POST] /api/datasetmanagement/viewModel
Request Schema
Response
Status Code: 200
Success
[GET] /api/datasetmanagement/download/{param}
Parameters
Name | Type | Located In |
---|---|---|
param | string | query |
Response
Status Code: 200
Success
binary
[POST] /api/datasetmanagement/sqlValidate/{param}
Parameters
Name | Type | Located In |
---|---|---|
param | string | query |
Request Schema
Response
Status Code: 200
Success
[GET] /api/dataset/getcssurl
Parameters
Name | Type | Located In |
---|---|---|
cssName | string | query |
theme | string | query |
Response
Status Code: 200
Success
[GET] /api/dataset/getjsasseturlprefix
Response
Status Code: 200
Success
[GET] /api/datasetmanagement/licenseinfo
Response
Status Code: 200
Success
[POST] /api/datasetmanagement/revert/{datasetId}/{revision}
Parameters
Name | Type | Located In |
---|---|---|
datasetIdRequired | string | path |
revisionRequired | int32 | path |
Response
Status Code: 200
Success
[GET] /api/models/download/{param}
Parameters
Name | Type | Located In |
---|---|---|
param | string | query |
Response
Status Code: 200
Success
binary
[GET] /api/datasetmanagement/cached-datasets
Response
Status Code: 200
Success
[GET] /api/datasetmanagement/cots
Response
Status Code: 200
Success
[GET] /api/semantic
Response
Status Code: 200
Success
[POST] /api/semantic
Request Schema
SemanticViewModels+CreateSemanticModelRequestModel
Response
Status Code: 200
Success
[POST] /api/semantic/upload
Response
Status Code: 200
Success
[POST] /api/semantic/nameexist
Request Schema
SemanticViewModels+ValidateNameModel
Response
Status Code: 200
Success
boolean
[GET] /api/semantic/{documentId}/info
Parameters
Name | Type | Located In |
---|---|---|
documentIdRequired | string | path |
Response
Status Code: 200
Success
[GET] /api/semantic/{documentId}/draft
Parameters
Name | Type | Located In |
---|---|---|
documentIdRequired | string | path |
Response
Status Code: 200
Success
[GET] /api/semantic/{id}/draft/entities/{entityId}
Parameters
Name | Type | Located In |
---|---|---|
idRequired | string | path |
entityIdRequired | string | path |
Response
Status Code: 200
Success
[GET] /api/semantic/{documentId}/file
Parameters
Name | Type | Located In |
---|---|---|
documentIdRequired | string | path |
Response
Status Code: 200
Success
binary
[GET] /api/semantic/models
Response
Status Code: 200
Success
[GET] /api/semantic/{documentId}/entities
Parameters
Name | Type | Located In |
---|---|---|
documentIdRequired | string | path |
Response
Status Code: 200
Success
[GET] /api/semantic/{documentId}/content
Parameters
Name | Type | Located In |
---|---|---|
documentIdRequired | string | path |
Response
Status Code: 200
Success
[GET] /api/semantic/{documentId}/title
Parameters
Name | Type | Located In |
---|---|---|
documentIdRequired | string | path |
Response
Status Code: 200
Success
[POST] /api/semantic/{documentId}/scope
Parameters
Name | Type | Located In |
---|---|---|
documentIdRequired | string | path |
Request Schema
SemanticViewModels+EntityScopeRequest
Response
Status Code: 200
Success
SemanticViewModels+EntityScopeResponse
[POST] /api/semantic/revert/{modelId}/{revision}
Parameters
Name | Type | Located In |
---|---|---|
modelIdRequired | string | path |
revisionRequired | int32 | path |
Response
Status Code: 200
Success
Models
Ƭ WorkerTaskStatus
Name | Type | Description | Example |
---|---|---|---|
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
Ƭ BatchRefreshModel
Name | Type | Description | Example |
---|---|---|---|
refreshDataSetIdsNullable | Array<string> |
||
cotSearchEntryInfosNullable | SearchEntryInfo |
Ƭ SearchEntryInfo
Name | Type | Description | Example |
---|---|---|---|
tenantIdNullable | string | ||
datasetIdNullable | string |
Ƭ DataEndpointQueryModel+DataSet
Name | Type | Description | Example |
---|---|---|---|
datasetIdNullable | string | ||
revisionNullable | int32 | ||
previewRowsNullable | int32 | ||
parametersNullable | DataEndpointQueryModel+DataSet+Parameter |
Ƭ DataEndpointQueryModel+DataSet+Parameter
Name | Type | Description | Example |
---|---|---|---|
nameNullable | string | ||
valueNullable | string |
Ƭ DataEndpointQueryModel+DataSource
Name | Type | Description | Example |
---|---|---|---|
datasourceIdNullable | string | ||
revisionNullable | int32 | ||
sqlNullable | string | ||
parametersNullable | DataEndpointQueryModel+DataSource+Parameter |
Ƭ DataEndpointQueryModel+DataSource+Parameter
Name | Type | Description | Example |
---|---|---|---|
nameNullable | string | ||
valueNullable | string |
Ƭ DataEndpointQueryModel+Semantic
Name | Type | Description | Example |
---|---|---|---|
datasourceIdNullable | string | ||
revisionNullable | int32 | ||
semanticQueryNullable | string | ||
parametersNullable | DataEndpointQueryModel+Semantic+Parameter |
Ƭ DataEndpointQueryModel+Semantic+Parameter
Name | Type | Description | Example |
---|---|---|---|
nameNullable | string | ||
valueNullable | string |
Ƭ System.Collections.Generic.KeyValuePair`2[[System.String, System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e],[GrapeCity.Enterprise.Data.DataEngine.Aggregates.AggregateFunction, Gcef.Data.DataEngine, Version=4.0.0.0, Culture=neutral, PublicKeyToken=0b5e1563d2869208]]
Name | Type | Description | Example |
---|---|---|---|
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 | Description | Example |
---|---|---|---|
nameNullable | string | ||
query | QueryViewModel | ||
fieldsNullable | FieldViewModel | ||
groupFieldsNullable | FieldViewModel | ||
customSqlTablesNullable | CustomSqlTableViewModel | ||
filterExpressionsNullable | FilterExpression | ||
filterConditions | FilterCondition | ||
indexed | Boolean | ||
tagIdsNullable | Array<string> |
||
commentNullable | string | ||
incrementalUpdateSetting | IncrementalUpdateFilterViewModel | ||
waxExpressionsNullable | WAXExpressionViewModel | ||
useTenantBasedCaches | Boolean | ||
enableViews | Boolean | ||
datasetViewsNullable | DatasetViewViewModel |
Ƭ QueryViewModel
Name | Type | Description | Example |
---|---|---|---|
dataSourcesNullable | DataSourceViewModel | ||
parametersNullable | QueryParameterViewModel | ||
commandTextNullable | string | ||
commandTypeNullable | string | ||
commandModel | TableJoinQueryViewModel |
Ƭ 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 |
Ƭ CustomSqlTableViewModel
Name | Type | Description | Example |
---|---|---|---|
datasourceNullable | string | ||
nameNullable | string | ||
queryType | QueryType | ||
sqlCommandNullable | string | ||
querySchemaNullable | string | ||
procedureSchemaNullable | string | ||
procedureNameNullable | string | ||
procedureParametersNullable | CustomTableProcedureParameterViewModel |
Ƭ FilterExpression
Name | Type | Description | Example |
---|---|---|---|
typeNullable | string | ||
tableNullable | string | ||
columnNullable | string | ||
expressionNullable | string | ||
operatorNullable | string | ||
valueNullable | Array |
||
valueTypeNullable | string | ||
targetTypeNullable | string | ||
multivalue | Boolean |
Ƭ FilterCondition
Name | Type | Description | Example |
---|---|---|---|
conditionType | ConditionType | ||
conditionItemsNullable | FilterCondition | ||
typeNullable | string | ||
tableNullable | string | ||
columnNullable | string | ||
expressionNullable | string | ||
operatorNullable | string | ||
valueNullable | Array |
||
valueTypeNullable | string | ||
targetTypeNullable | string | ||
multivalue | Boolean |
Ƭ IncrementalUpdateFilterViewModel
Name | Type | Description | Example |
---|---|---|---|
tableNullable | string | ||
fieldNullable | string | ||
aliasNullable | string |
Ƭ WAXExpressionViewModel
Name | Type | Description | Example |
---|---|---|---|
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 | Description | Example |
---|---|---|---|
viewIdNullable | string | ||
viewNameNullable | string | ||
priority | int32 | ||
fieldsNullable | MaskedFieldViewModel | ||
condition | DatasetViewConditionViewModel |
Ƭ DataSourceViewModel
Name | Type | Description | Example |
---|---|---|---|
idNullable | string | ||
nameNullable | string | ||
fileNameNullable | string | ||
providerNullable | string | ||
useAdvancedConfig | Boolean | ||
connectionStringNullable | string | ||
mappingConfigsNullable | TableMappingInfo | ||
useUserContext | Boolean | ||
useMultiTenant | Boolean | ||
isExtracted | Boolean | ||
supportNativeQuery | Boolean | ||
typeNullable | string |
Ƭ QueryParameterViewModel
Name | Type | Description | Example |
---|---|---|---|
nameNullable | string | ||
parameterTypeNullable | string | ||
parameterValueNullable | string | ||
parameterDefaultValueNullable | string | ||
dataTypeNullable | string | ||
multivalue | Boolean | ||
tableNullable | string |
Ƭ TableJoinQueryViewModel
Name | Type | Description | Example |
---|---|---|---|
firstTable | TableViewModel | ||
joinRelationsNullable | JoinRelationViewModel |
Ƭ TableMappingInfo
Name | Type | Description | Example |
---|---|---|---|
tableOriginalNameNullable | string | ||
tableDisplayNameNullable | string | ||
columnsNullable | ColumnMappingInfo |
Ƭ ColumnMappingInfo
Name | Type | Description | Example |
---|---|---|---|
columnOriginalNameNullable | string | ||
columnDisplayNameNullable | string |
Ƭ TableViewModel
Name | Type | Description | Example |
---|---|---|---|
idNullable | string | ||
tableTypeNullable | string | ||
tableNameNullable | string | ||
sqlNullable | string | ||
querySchemaNullable | 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 |
Ƭ JoinConditionViewModel
Name | Type | Description | Example |
---|---|---|---|
leftColumn | JoinColumnViewModel | ||
operatorNullable | string | ||
rightColumn | JoinColumnViewModel |
Ƭ JoinColumnViewModel
Name | Type | Description | Example |
---|---|---|---|
columnNameNullable | string | ||
tableNameNullable | string |
Ƭ QueryType
Enum:
Text
StoredProcedure
Ƭ CustomTableProcedureParameterViewModel
Name | Type | Description | Example |
---|---|---|---|
parameterNameNullable | string | ||
parameterTypeNullable | string | ||
parameterModeNullable | string | ||
parameterPositionNullable | string | ||
parameterDefaultValueNullable | string | ||
parameterValueTypeNullable | string | ||
isOutResultSet | Boolean |
Ƭ ConditionType
Enum:
AndGroup
OrGroup
Rule
Ƭ MaskedFieldViewModel
Name | Type | Description | Example |
---|---|---|---|
fieldNameNullable | string | Field Name | |
descriptionNullable | string | Field Description | |
dataTypeNullable | string | DataType | |
fieldStatus | FieldStatus | ||
redactedValueNullable | any | RedactedValue |
Ƭ DatasetViewConditionViewModel
Name | Type | Description | Example |
---|---|---|---|
conditionType | DatasetViewConditionType | ||
itemsNullable | 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
Ƭ PreviewDatasetViewModel
Name | Type | Description | Example |
---|---|---|---|
dataSetDoc | DatasetViewModel | ||
parametersNullable | DatasetParameterValue |
Ƭ DatasetParameterValue
Name | Type | Description | Example |
---|---|---|---|
nameNullable | string | ||
valueNullable | Array |
Ƭ PreivewCustomTableViewModel
Name | Type | Description | Example |
---|---|---|---|
tableNameNullable | string | ||
connectIdNullable | string | ||
queryType | QueryType | ||
sqlCommandNullable | string | ||
querySchemaNullable | string | ||
rowLimit | int32 | ||
parametersNullable | string | ||
parameterValuesNullable | DatasetParameterValue | ||
dataSourceParametersNullable | DataSourceParameter | ||
procedureSchemaNullable | string | ||
procedureNameNullable | string | ||
procedureParametersNullable | CustomTableProcedureParameterViewModel |
Ƭ DataSourceParameter
Name | Type | Description | Example |
---|---|---|---|
nameNullable | string | ||
valueNullable | string | ||
dataTypeNullable | string | ||
isMultivalued | Boolean | ||
delimiterNullable | string | ||
tableNameNullable | string |
Ƭ PreviewTableViewModel
Name | Type | Description | Example |
---|---|---|---|
datasourceIdNullable | string | ||
schemaNameNullable | string | ||
tableNameNullable | string | ||
rowLimit | int32 | ||
dataSourceParametersNullable | DataSourceParameter |
Ƭ QueryEmbedDatasetModel
Name | Type | Description | Example |
---|---|---|---|
dataset | DataSetDocument | ||
parametersNullable | DatasetParameterValue |
Ƭ DataSetDocument
Name | Type | Description | Example |
---|---|---|---|
nameNullable | string | ||
query | DataSetQuery | ||
fieldsNullable | DataSetField | ||
groupFieldsNullable | DataSetField | ||
filtersNullable | DataSetFilter | ||
filterConditions | DataSetFilterTree | ||
customSqlTablesNullable | DataSetCustomTable | ||
indexed | Boolean | ||
incrementalUpdateSettings | IncrementalUpdateSettings | ||
enableViews | Boolean | ||
datasetViewsNullable | DatasetView | ||
waxExpressionsNullable | WAXExpression | ||
useTenantBasedCaches | Boolean |
Ƭ DataSetQuery
Name | Type | Description | Example |
---|---|---|---|
dataSourcesNullable | DataSetQuerySource | ||
queryParametersNullable | DataSetQueryParameter | ||
commandTextNullable | string | ||
sqlParametersNullable | DataSetQueryValue | ||
commandType | CommandType | ||
commandModel | TableJoinQuery |
Ƭ DataSetField
Name | Type | Description | Example |
---|---|---|---|
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 | Description | Example |
---|---|---|---|
filterExpressionNullable | string | ||
operatorNullable | string | ||
filterValueDataTypeNullable | string | ||
filterValue | FilterValue | ||
tableNullable | string | ||
columnNullable | string | ||
filterType | FilterType | ||
multivalue | Boolean |
Ƭ DataSetFilterTree
Name | Type | Description | Example |
---|---|---|---|
conditionType | ConditionType | ||
conditionItemsNullable | DataSetFilterTree | ||
filterExpressionNullable | string | ||
operatorNullable | string | ||
filterValueDataTypeNullable | string | ||
filterValue | FilterValue | ||
tableNullable | string | ||
columnNullable | string | ||
filterType | FilterType | ||
multivalue | Boolean |
Ƭ DataSetCustomTable
Name | Type | Description | Example |
---|---|---|---|
customNameNullable | string | ||
dataSourceIdNullable | string | ||
sqlCommandNullable | string | ||
querySchemaNullable | string | ||
queryType | QueryType | ||
procedureSchemaNullable | string | ||
procedureNameNullable | string | ||
procedureParameters | CustomTableProcedureParameterCollection |
Ƭ IncrementalUpdateSettings
Name | Type | Description | Example |
---|---|---|---|
filtersNullable | IncrementalUpdateFilter | ||
orderListNullable | OrderInfo |
Ƭ DatasetView
Name | Type | Description | Example |
---|---|---|---|
viewIdNullable | string | ||
viewNameNullable | string | ||
priority | int32 | ||
fieldsNullable | MaskedField | ||
condition | DatasetViewCondition |
Ƭ WAXExpression
Name | Type | Description | Example |
---|---|---|---|
nameNullable | string | ||
dataTypeNullable | string | ||
expressionNullable | string | ||
expressionType | WAXExpressionType |
Ƭ DataSetQuerySource
Name | Type | Description | Example |
---|---|---|---|
nameNullable | string | ||
idNullable | string | ||
type | DataSetQuerySourceType |
Ƭ DataSetQueryParameter
Name | Type | Description | Example |
---|---|---|---|
nameNullable | string | ||
parameterTypeNullable | string | ||
parameterValueNullable | string | ||
parameterDefaultValueNullable | string | ||
dataTypeNullable | string | ||
isMultivalue | Boolean | ||
tableNullable | string |
Ƭ DataSetQueryValue
Name | Type | Description | Example |
---|---|---|---|
parameterIdentifierNullable | string | ||
parameterNameNullable | string | ||
valueNullable | any | ||
targetTypeNullable | string |
Ƭ CommandType
Enum:
Sql
Model
Ƭ TableJoinQuery
Name | Type | Description | Example |
---|---|---|---|
firstTable | TableQuery | ||
joinRelationsNullable | JoinQuery |
Ƭ DataSetQuerySourceType
Enum:
DataSource
CachedDataset
DirectDataset
Ƭ TableQuery
Name | Type | Description | Example |
---|---|---|---|
idNullable | string | ||
tableType | TableType | ||
tableNameNullable | string | ||
sqlNullable | string | ||
querySchemaNullable | string | ||
dataSourceIdNullable | string | ||
unionType | UnionType | ||
unionMapNullable | Array<object> |
||
filtersNullable | DataSetFilter | ||
sQlExpressionsNullable | DataSetField | ||
tablesNullable | TableQuery | ||
parametersNullable | DataSetQueryValue |
Ƭ JoinQuery
Name | Type | Description | Example |
---|---|---|---|
joinTypeNullable | string | ||
rightTable | TableQuery | ||
conditionsNullable | JoinCondition |
Ƭ TableType
Enum:
NativeTable
UnionTable
CustomSqlTable
ReferencedDataset
Ƭ UnionType
Enum:
None
Union
UnionAll
Ƭ FilterValue
Name | Type | Description | Example |
---|---|---|---|
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 | Description | Example |
---|---|---|---|
leftColumn | ColumnIdentity | ||
operatorNullable | string | ||
rightColumn | ColumnIdentity |
Ƭ ColumnIdentity
Name | Type | Description | Example |
---|---|---|---|
tableNameNullable | string | ||
columnNameNullable | string |
Ƭ CustomTableProcedureParameterCollection
Name | Type | Description | Example |
---|---|---|---|
parametersNullable | CustomTableProcedureParameter |
Ƭ CustomTableProcedureParameter
Name | Type | Description | Example |
---|---|---|---|
parameterNameNullable | string | ||
parameterModeNullable | string | ||
parameterTypeNullable | string | ||
parameterPositionNullable | string | ||
parameterValueTypeNullable | string | ||
parameterDefaultValueNullable | string | ||
isOutResultSet | Boolean |
Ƭ IncrementalUpdateFilter
Name | Type | Description | Example |
---|---|---|---|
filterType | FilterType | ||
operatorNullable | string | ||
tableNullable | string | ||
fieldNullable | string | ||
nameNullable | string |
Ƭ OrderInfo
Name | Type | Description | Example |
---|---|---|---|
nameNullable | string | ||
orderNullable | string |
Ƭ MaskedField
Name | Type | Description | Example |
---|---|---|---|
fieldNameNullable | string | ||
dataTypeNullable | string | ||
descriptionNullable | string | ||
fieldStatus | FieldStatus | ||
redactedValueNullable | any |
Ƭ DatasetViewCondition
Name | Type | Description | Example |
---|---|---|---|
conditionType | DatasetViewConditionType | ||
itemsNullable | DatasetViewCondition | ||
filterKeyNullable | string | ||
filterValueNullable | any | ||
filterDataTypeNullable | string | ||
filterType | DatasetViewFilterType | ||
operator | DatasetViewConditionOperator | ||
indexNullable | string |
Ƭ WAXExpressionType
Enum:
Measure
CalculatedColumn
Ƭ SemanticViewModels+ModelEx
Represent a semantic model.
Name | Type | Description | Example |
---|---|---|---|
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 | SemanticViewModels+EntityEx | Get or set semantic model entities. | |
displayNameNullable | string | Semantic model translate title |
Ƭ SemanticViewModels+EntityEx
Semantic model entity.
Name | Type | Description | Example |
---|---|---|---|
attributesNullable | AttributeContract | Entity attributes. | |
relationsNullable | RelationContract | Entity relations. | |
parametersNullable | 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 | SemanticViewModels+SimpleAttributeContract | Entity default aggregate attributes. | |
defaultDetailAttributesNullable | SemanticViewModels+SimpleAttributeContract | Entity default detail attributes. | |
identifyingAttributesNullable | SemanticViewModels+SimpleAttributeContract | Entity identifying attributes. |
Ƭ AttributeContract
Represent attribute contract.
Name | Type | Description | Example |
---|---|---|---|
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 | AttributeContract | Attribute variations. | |
expressionTextNullable | string | Attribute expression text. | |
nameNullable | string | ||
descriptionNullable | string |
Ƭ RelationContract
Represent realtion contract.
Name | Type | Description | Example |
---|---|---|---|
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 | Description | Example |
---|---|---|---|
idNullable | string | ||
nameNullable | string | ||
dataTypeNullable | string | ||
valueNullable | string | ||
defaultValueNullable | string | ||
validValuesNullable | SemanticViewModels+_ParameterValue | ||
allowNullNullable | Boolean | ||
promptNullable | string |
Ƭ SecurityFilterContract
Name | Type | Description | Example |
---|---|---|---|
id | string | ||
filterNameNullable | string | ||
existingFilterPathNullable | string | ||
attributePathNullable | string | ||
expressionNullable | string | ||
operationNullable | string |
Ƭ SemanticViewModels+SimpleAttributeContract
Name | Type | Description | Example |
---|---|---|---|
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 | Description | Example |
---|---|---|---|
labelNullable | string | ||
valueNullable | string |
Ƭ SemanticViewModels+CreateSemanticModelRequestModel
Name | Type | Description | Example |
---|---|---|---|
nameNullable | string | ||
providerNullable | string | ||
connectionStringNullable | string | ||
tablesNullable | Array<string> |
||
findRelations | Boolean | ||
commandTimeoutNullable | string |
Ƭ SemanticViewModels+ValidateNameModel
Represent semantic model name validatation model.
Name | Type | Description | Example |
---|---|---|---|
idNullable | string | Get or set semantic model id. | |
name | string | Get or set semantic model name. |
Ƭ SemanticViewModels+ModelInfo
Represent a semantic model info model.
Name | Type | Description | Example |
---|---|---|---|
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 | Example |
---|---|---|---|
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 | Example |
---|---|---|---|
entitiesNullable | SemanticViewModels+Entity | Get or set semantic model entities. |
Ƭ SemanticViewModels+Entity
Represent semantic model content entity model.
Name | Type | Description | Example |
---|---|---|---|
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 | SemanticViewModels+Attribute | Get or set semantic model entity attributes. | |
relationsNullable | SemanticViewModels+Relation | Get or set semantic model entity relations. | |
parametersNullable | 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 | Description | Example |
---|---|---|---|
idNullable | string | ||
nameNullable | string | ||
hidden | Boolean | ||
dataTypeNullable | string | ||
logicalDataTypeNullable | string | ||
formatNullable | string | ||
isAggregate | Boolean | ||
discourageGrouping | Boolean | ||
variationsNullable | SemanticViewModels+Attribute | ||
descriptionNullable | string |
Ƭ SemanticViewModels+Relation
Name | Type | Description | Example |
---|---|---|---|
idNullable | string | ||
nameNullable | string | ||
hidden | Boolean | ||
cardinalityNullable | string | ||
relatedEntityIdNullable | string | ||
hiddenFieldsNullable | Array<string> |
||
descriptionNullable | string |
Ƭ SemanticViewModels+ParameterForReport
Name | Type | Description | Example |
---|---|---|---|
idNullable | string | ||
isSpecial | Boolean | ||
nameNullable | string | ||
dataTypeNullable | string | ||
valueNullable | string | ||
defaultValue | EntityProcedureUiParameterValue | ||
validValuesDomain | EntityProcedureUiParameterValidValuesDomain | ||
validValuesNullable | EntityProcedureUiParameterValue | ||
attributeReference | EntityProcedureUiAtributeReference | ||
allowNullNullable | Boolean | ||
promptNullable | string |
Ƭ EntityProcedureUiParameterValue
Represent entity procedure UI parameter value.
Name | Type | Description | Example |
---|---|---|---|
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 | Example |
---|---|---|---|
nameNullable | string | Attribute name. | |
pathNullable | string | Attribute path. | |
valuesNullable | EntityProcedureUiParameterValue | Entity procedure UI attribute reference values. |
Ƭ SemanticViewModels+EntityScopeResponse
Represent a semantic model entities scope response model.
Name | Type | Description | Example |
---|---|---|---|
entitiesNullable | 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 | Example |
---|---|---|---|
scopesNullable | SemanticViewModels+EntityScope | Get or set an entity scope list. | |
excludedIdsNullable | Array<string> |
Get or set an excluded entity id list. |
Ƭ SemanticViewModels+EntityScope
Name | Type | Description | Example |
---|---|---|---|
baseEntityNameNullable | string | ||
attributePathsNullable | Array<string> |
||
byIdNullable | Boolean | ||
withRelationsNullable | Boolean |