[]
Parameters
| Name | In | Type |
|---|---|---|
| title | query | string |
Responses
[200] Success
Parameters
| Name | In | Type |
|---|---|---|
| id | query | string |
| title | query | string |
Responses
[200] Success
Parameters
| Name | In | Type |
|---|---|---|
| cssName | query | string |
| theme | query | string |
Responses
[200] Success
Responses
[200] Success
Responses
[200] Success
Responses
[200] Success
Request Body
Type: application/json-patch+json, application/json, text/json, application/*+json
Responses
[200] Success
Type: [text/plain], [application/json], [text/json]
Parameters
| Name | In | Type |
|---|---|---|
| queryIdRequired | path | string |
Responses
[200] Success
Type: [text/plain], [application/json], [text/json]
Request Body
Type: application/json-patch+json, application/json, text/json, application/*+json
Responses
[200] Success
Type: [text/plain], [application/json], [text/json]
Responses
[200] Success
Type: [text/plain], [application/json], [text/json]
Request Body
Type: application/json-patch+json, application/json, text/json, application/*+json
ListMultipleDsTableNamesRequestViewModel
Responses
[200] Success
Type: [text/plain], [application/json], [text/json]
Request Body
Type: application/json-patch+json, application/json, text/json, application/*+json
Responses
[200] Success
Type: [text/plain], [application/json], [text/json]
Request Body
Type: application/json-patch+json, application/json, text/json, application/*+json
Responses
[200] Success
Type: [text/plain], [application/json], [text/json]
Parameters
| Name | In | Type |
|---|---|---|
| modelDocIdRequired | path | string |
Responses
[200] Success
Type: [text/plain], [application/json], [text/json]
Request Body
Type: application/json-patch+json, application/json, text/json, application/*+json
ValidateRelationRequestViewModel
Responses
[200] Success
Type: [text/plain], [application/json], [text/json]
Request Body
Type: application/json-patch+json, application/json, text/json, application/*+json
Responses
[200] Success
Type: [text/plain], [application/json], [text/json]
Request Body
Type: application/json-patch+json, application/json, text/json, application/*+json
Responses
[200] Success
Type: [text/plain], [application/json], [text/json]
Parameters
| Name | In | Type |
|---|---|---|
| queryIdRequired | path | string |
Responses
[200] Success
Type: [text/plain], [application/json], [text/json]
Parameters
| Name | In | Type |
|---|---|---|
| docIdRequired | path | string |
Responses
[200] Success
Type: [text/plain], [application/json], [text/json]
Parameters
| Name | In | Type |
|---|---|---|
| modelIdRequired | path | string |
Responses
[200] Success
Type: [text/plain], [application/json], [text/json]
Parameters
| Name | In | Type |
|---|---|---|
| docIdRequired | path | string |
Responses
[200] Success
Type: [text/plain], [application/json], [text/json]
Parameters
| Name | In | Type |
|---|---|---|
| docIdRequired | path | string |
Request Body
Type: application/json-patch+json, application/json, text/json, application/*+json
PortalReloadDataRequestViewModel
Responses
[200] Success
Type: [text/plain], [application/json], [text/json]
Request Body
Type: application/json-patch+json, application/json, text/json, application/*+json
ValidateEntityBindingRequestViewModel
Responses
[200] Success
Type: [text/plain], [application/json], [text/json]
Request Body
Type: application/json-patch+json, application/json, text/json, application/*+json
ValidateAttributeBindingRequestViewModel
Responses
[200] Success
Type: [text/plain], [application/json], [text/json]
Request Body
Type: application/json-patch+json, application/json, text/json, application/*+json
ValidateIncrementalSettingRequestViewModel
Responses
[200] Success
Type: [text/plain], [application/json], [text/json]
Parameters
| Name | In | Type | Default |
|---|---|---|---|
| pageSize | query | integer | -1 |
| pageNumber | query | integer | -1 |
| orderBy | query | string | "" |
| search | query | string | "" |
| invalid | query | boolean | false |
Responses
[200] Success
Type: [text/plain], [application/json], [text/json]
Tests connection with given connection string and provider.
Request Body
Type: application/json-patch+json, application/json, text/json, application/*+json
TestConnectionRequestViewModel
Responses
[200] Success
Type: [text/plain], [application/json], [text/json]
Lists database names of given datasource.
Request Body
Type: application/json-patch+json, application/json, text/json, application/*+json
Responses
[200] Success
Type: [text/plain], [application/json], [text/json]
Lists table names of given datasource.
Request Body
Type: application/json-patch+json, application/json, text/json, application/*+json
ListTableNamesRequestViewModel
Responses
[200] Success
Type: [text/plain], [application/json], [text/json]
Lists column names of given entity info.
The entity can be bound to physical database table or custom-SQL-table.
Request Body
Type: application/json-patch+json, application/json, text/json, application/*+json
ListColumnNamesRequestViewModel
Responses
[200] Success
Type: [text/plain], [application/json], [text/json]
Detects entities and relations on given datasource to create an model.
Request Body
Type: application/json-patch+json, application/json, text/json, application/*+json
AutoCreateModelRequestViewModel
Responses
[200] Success
Type: [text/plain], [application/json], [text/json]
Validates the data binding of given entity info
Request Body
Type: application/json-patch+json, application/json, text/json, application/*+json
ValidateEntityBindingRequestViewModel
Responses
[200] Success
Type: [text/plain], [application/json], [text/json]
Validates the data binding of given entity parameters
Request Body
Type: application/json-patch+json, application/json, text/json, application/*+json
ValidateEntityBindingRequestViewModel
Responses
[200] Success
Type: [text/plain], [application/json], [text/json]
Validates the data binding of given attribute info
Request Body
Type: application/json-patch+json, application/json, text/json, application/*+json
ValidateAttributeBindingRequestViewModel
Responses
[200] Success
Type: [text/plain], [application/json], [text/json]
Validates the relation of given relation info
Request Body
Type: application/json-patch+json, application/json, text/json, application/*+json
ValidateRelationRequestViewModel
Responses
[200] Success
Type: [text/plain], [application/json], [text/json]
Responses
[200] Success
Type: [text/plain], [application/json], [text/json]
Request Body
Type: application/json-patch+json, application/json, text/json, application/*+json
Responses
[200] Success
Type: [text/plain], [application/json], [text/json]
validate the data of local entity and complete attributes
Request Body
Type: application/json-patch+json, application/json, text/json, application/*+json
ValidateLocalEntityDataRequestViewModel
Responses
[200] Success
Type: [text/plain], [application/json], [text/json]
Validates integrity of given model.
Request Body
Type: application/json-patch+json, application/json, text/json, application/*+json
Responses
[200] Success
Type: [text/plain], [application/json], [text/json]
Stores given model, designer view and datasource info into the storage.
Request Body
Type: application/json-patch+json, application/json, text/json, application/*+json
Responses
[200] Success
Type: [text/plain], [application/json], [text/json]
Updates persisted document content with given model, designer view and datasource.
Request Body
Type: application/json-patch+json, application/json, text/json, application/*+json
Responses
[200] Success
Type: [text/plain], [application/json], [text/json]
Loads specified existing analysis-model-document.
Request Body
Type: application/json-patch+json, application/json, text/json, application/*+json
Responses
[200] Success
Type: [text/plain], [application/json], [text/json]
Request Body
Type: application/json-patch+json, application/json, text/json, application/*+json
Responses
[200] Success
Type: [text/plain], [application/json], [text/json]
Request Body
Type: application/json-patch+json, application/json, text/json, application/*+json
Responses
[200] Success
boolean
Type: [text/plain], [application/json], [text/json]
Request Body
Type: application/json-patch+json, application/json, text/json, application/*+json
datasourceId
Responses
[200] Success
Type: [text/plain], [application/json], [text/json]
Request Body
Type: application/json-patch+json, application/json, text/json, application/*+json
ValidateDataSourcesRequestViewModel
Responses
[200] Success
Type: [text/plain], [application/json], [text/json]
| Name | Type |
|---|---|
| succeeded | Boolean |
| errorCode | int32 |
| errorDataDictNullable | string |
| resultNullable | any |
| innerError | InnerError |
| Name | Type |
|---|---|
| errorCode | int32 |
| errorDataDictNullable | string |
| messageNullable | string |
| callStackNullable | string |
| inner | InnerError |
!:AnalysisController.GetData(GetDataRequestViewModel)
| Name | Type |
|---|---|
| documentIdNullable | string |
| lockNoNullable | string |
| dataSourceInfo | DataSourceInfoViewModel |
| entitiesNullable | Array<EntityViewModel> |
| Name | Type |
|---|---|
| idNullable | string |
| type | DataSourceType |
| providerNullable | string |
| connectionStringNullable | string |
| documentIdNullable | string |
| documentVersionNullable | int32 |
| Name | Type |
|---|---|
| idNullable | string |
| nameNullable | string |
| bindingNullable | string |
| bindingType | ViewModelEntityBindingType |
| attributesNullable | Array<AttributeViewModel> |
| isHidden | Boolean |
| entityParameterCollection | EntityParameterCollectionViewModel |
| dataSourceIdNullable | string |
| generatedNameNullable | string |
| isSupportIncrementalUpdate | Boolean |
Enum:
EmbeddedReferencedDataFileEnum:
DatabaseTableCustomSQLTableLocalEntity| Name | Type |
|---|---|
| idNullable | string |
| nameNullable | string |
| bindingNullable | string |
| isNullable | Boolean |
| isUnique | Boolean |
| bindingType | ViewModelAttributeBindingType |
| dataType | ViewModelAttributeLogicalDataType |
| dataVizAIHint | DataVizAIHint |
| clrDataTypeNameNullable | string |
| isHidden | Boolean |
| isDate | Boolean |
| generatedNameNullable | string |
| isContainTimeZoneNullable | Boolean |
| originNameNullable | string |
| isUnsupportedNullable | Boolean |
| Name | Type |
|---|---|
| entityParametersNullable | Array<EntityParameterViewModel> |
Enum:
DatabaseTableColumnPrimitiveSQLExpressionEnum:
NumberTextBooleanBinaryGUIDDateDateTimeUnknownEnum:
NoneCurrencyImageURLImageBinaryGeoRegionGeoLatitudeGeoLongitude| Name | Type |
|---|---|
| parameterNameNullable | string |
| literalValueNullable | string |
| valueType | AttributeLogicalDataType |
| isMultivalued | Boolean |
Enum:
NumberTextBooleanBinaryGUIDDateDateTimeUnknown!:AnalysisController.Heartbeat(HeartbeatRequestViewModel)
| Name | Type |
|---|---|
| modelDocIdNullable | string |
| lockNoNullable | string |
!:AnalysisController.ListMultiDsTableNames(ListTableNamesRequestViewModel)
| Name | Type |
|---|---|
| dataSourceInfosNullable | Array<DataSourceInfoViewModel> |
!:AnalysisController.Close(CloseRequestViewModel)
| Name | Type |
|---|---|
| modelDocIdNullable | string |
| lockNoNullable | string |
| Name | Type |
|---|---|
| documentIdNullable | string |
| dataSourceInfo | DataSourceInfoViewModel |
| previewEntity | PreviewEntityViewModel |
| filterCondition | PreviewSecurityFilterConditionViewModel |
| filterContextValuesNullable | Array<PreviewSecurityFilterContextValue> |
| rowLimitNullable | int32 |
| contextValueProvider | IContextValueProvider |
| Name | Type |
|---|---|
| entityBinding | EntityBindingViewModel |
| attributeBindingsNullable | Array<PreviewAttributeViewModel> |
| entityParameterCollection | EntityParameterCollectionViewModel |
| Name | Type |
|---|---|
| leftType | EntityConditionRuleType |
| leftValueNullable | string |
| dataTypeNullable | string |
| operator | EntityConditionOperator |
| rightType | EntityConditionRuleType |
| rightValueNullable | string |
| type | EntityConditionType |
| itemsNullable | Array<PreviewSecurityFilterConditionViewModel> |
| Name | Type |
|---|---|
| contextType | EntityConditionRuleType |
| contextNameNullable | string |
| contextValueNullable | Array |
| isMultipleValue | Boolean |
| Name | Type |
|---|
| Name | Type |
|---|---|
| idNullable | string |
| bindingType | ViewModelEntityBindingType |
| bindingNullable | string |
| tableNullable | string |
| schemaNullable | string |
| Name | Type |
|---|---|
| idNullable | string |
| nameNullable | string |
| bindingNullable | string |
| clrDataTypeNameNullable | string |
| dataType | ViewModelAttributeLogicalDataType |
| bindingType | ViewModelAttributeBindingType |
| isDate | Boolean |
Enum:
AttributeUserContextOrganizationContextConstantOtherEntityAttributeEnum:
EqualToNotEqualToLessThanLessThanOrEqualToGreaterThanGreaterThanOrEqualToIsNotIsInNotInContainsNotContainsStartsWithNotStartsWithEndsWithNotEndsWithEnum:
AndGroupOrGroupRule!:AnalysisController.ValidateRelation(ValidateRelationRequestViewModel)
| Name | Type |
|---|---|
| documentIdNullable | string |
| dataSourceInfo | DataSourceInfoViewModel |
| relation | RelationViewModel |
| sourceEntity | EntityViewModel |
| targetEntity | EntityViewModel |
| Name | Type |
|---|---|
| idNullable | string |
| nameNullable | string |
| type | ViewModelRelationType |
| sourceAttributesNullable | Array<string> |
| targetAttributesNullable | Array<string> |
| bidirectionCrossFiltering | Boolean |
| isInactive | Boolean |
Enum:
OneToOneOneToManyOptionalOneToManyManyToOneManyToOptionalOne!:AnalysisController.ReloadData(ReloadRequestViewModel)
| Name | Type |
|---|---|
| documentIdNullable | string |
| lockNoNullable | string |
| dataSourceInfosNullable | Array<DataSourceInfoViewModel> |
| entitiesNullable | Array<EntityViewModel> |
| incrementalEntitiesNullable | Array<IncrementalEntityViewModel> |
| Name | Type |
|---|---|
| entityIdNullable | string |
| attributeIdNullable | string |
| Name | Type |
|---|---|
| documentIdNullable | string |
| lockNoNullable | string |
| dataSourceInfo | DataSourceInfoViewModel |
| entity | EntityViewModel |
| Name | Type |
|---|---|
| entityIdsNullable | Array<string> |
| incrementalEntityIdsNullable | Array<string> |
!:AnalysisController.ValidateEntityBinding(ValidateEntityBindingRequestViewModel)
| Name | Type |
|---|---|
| dataSourceInfo | DataSourceInfoViewModel |
| entityBinding | EntityBindingViewModel |
| modelType | ViewModelModelType |
Enum:
DirectQueryCacheMode!:AnalysisController.ValidateAttributeBinding(ValidateAttributeBindingRequestViewModel)
| Name | Type |
|---|---|
| dataSourceInfo | DataSourceInfoViewModel |
| attributeBinding | AttributeBindingViewModel |
| otherAttributeBindingsNullable | Array<AttributeBindingViewModel> |
| entityBinding | EntityBindingViewModel |
| Name | Type |
|---|---|
| bindingType | ViewModelAttributeBindingType |
| bindingNullable | string |
| dataType | ViewModelAttributeLogicalDataType |
!:AnalysisController.ValidateIncrementalSetting(ValidateIncrementalSettingRequestViewModel)
| Name | Type |
|---|---|
| dataSourceInfo | DataSourceInfoViewModel |
| attributeBinding | AttributeBindingViewModel |
| entityBinding | EntityBindingViewModel |
!:AnalysisController.TestConnection(TestConnectionRequestViewModel)
| Name | Type |
|---|---|
| dataSourceInfo | DataSourceInfoViewModel |
!:AnalysisController.ListDataBases(ListDataBasesRequestViewModel)
| Name | Type |
|---|---|
| dataSourceInfo | DataSourceInfoViewModel |
!:AnalysisController.ListTableNames(ListTableNamesRequestViewModel)
| Name | Type |
|---|---|
| dataSourceInfo | DataSourceInfoViewModel |
!:AnalysisController.ListColumnNames(ListColumnNamesRequestViewModel)
| Name | Type |
|---|---|
| dataSourceInfo | DataSourceInfoViewModel |
| entityBinding | EntityBindingViewModel |
!:AnalysisController.AutoCreateModel(AutoCreateModelRequestViewModel)
| Name | Type |
|---|---|
| dataSourceInfo | DataSourceInfoViewModel |
| options | AutoCreateModelOptionsViewModel |
| modelType | ViewModelModelType |
| Name | Type |
|---|---|
| convertForeignKeysToRelations | Boolean |
| findRelatedTables | Boolean |
| notFilterUnsupported | Boolean |
| limitedTableNamesNullable | Array<LimitedTableNameViewModel> |
| Name | Type |
|---|---|
| schemaNullable | string |
| tableNullable | string |
| Name | Type |
|---|---|
| entity | EntityViewModel |
| dataPacket | DataPacketViewModel |
| dataSourceInfo | DataSourceInfoViewModel |
| Name | Type |
|---|---|
| idNullable | string |
| entityIdNullable | string |
| dataNullable | Array<array> |
| isZipCompressed | Boolean |
!:AnalysisController.ValidateModel(ValidateModelRequestViewModel)
| Name | Type |
|---|---|
| dataSourceInfosNullable | Array<DataSourceInfoViewModel> |
| modelType | ViewModelModelType |
| model | ModelViewModel |
| validateOnDatabase | Boolean |
| incrementalEntitiesNullable | Array<IncrementalEntityViewModel> |
| calculatedExpressionsNullable | Array<CalculatedExpressionViewModel> |
| securityFilterConditionsNullable | Array<SecurityFilterConditionViewModel> |
| Name | Type |
|---|---|
| entitiesNullable | Array<EntityViewModel> |
| relationsNullable | Array<RelationViewModel> |
| securityFiltersNullable | Array<SecurityFilterViewModel> |
| Name | Type |
|---|---|
| entityIdNullable | string |
| nameNullable | string |
| dataType | AttributeLogicalDataType |
| expressionNullable | string |
| type | CalculatedExpressionType |
| dataVizAIHint | DataVizAIHint |
| isHidden | Boolean |
| isError | Boolean |
| Name | Type |
|---|---|
| entityIdNullable | string |
| condition | ConditionViewModel |
| Name | Type |
|---|---|
| idNullable | string |
| nameNullable | string |
| sourceAttributeIdNullable | string |
| operator | ViewModelSecurityFilterOperator |
| contextPropertyNameNullable | string |
| contextType | ViewModelSecurityFilterContextType |
Enum:
EqualInNotEqualNotInEnum:
UserContextPropertyOrganizationContextPropertyEnum:
MeasureCalculatedColumn| Name | Type |
|---|---|
| leftType | EntityConditionRuleType |
| leftValueNullable | string |
| dataTypeNullable | string |
| operator | EntityConditionOperator |
| rightType | EntityConditionRuleType |
| rightValueNullable | string |
| type | EntityConditionType |
| itemsNullable | Array<ConditionViewModel> |
!:AnalysisController.Save(SaveViewRequestModel)
| Name | Type |
|---|---|
| dataSourceInfosNullable | Array<DataSourceInfoViewModel> |
| model | ModelViewModel |
| dataPacketsNullable | Array<DataPacketViewModel> |
| designerViewNullable | any |
| documentTitleNullable | string |
| saveCommentNullable | string |
| modelType | ViewModelModelType |
| incrementalEntitiesNullable | Array<IncrementalEntityViewModel> |
| calculatedExpressionsNullable | Array<CalculatedExpressionViewModel> |
| securityFilterConditionsNullable | Array<SecurityFilterConditionViewModel> |
| aiAssistantInfo | AIAssistantInfoViewModel |
AI Assistant information View model
| Name | Type | Description |
|---|---|---|
| enabled | Boolean | Whether support AI |
| descriptionNullable | string | Description for the data model |
| entitiesNullable | Array<EntityAIAssistantInfoViewModel> |
AI Assistant information of Model entities |
Model Entity AI assistant information
| Name | Type | Description |
|---|---|---|
| idNullable | string | Entity id |
| descriptionNullable | string | Entity description |
| columnsNullable | Array<ColumnAIAssistantInfoViewModel> |
Entity Columns AI Assistant information view model |
Column AI Assistant information
| Name | Type | Description |
|---|---|---|
| idNullable | string | column id |
| descriptionNullable | string | column description |
!:AnalysisController.Update(UpdateRequestViewModel)
| Name | Type |
|---|---|
| documentIdNullable | string |
| dataSourceInfosNullable | Array<DataSourceInfoViewModel> |
| model | ModelViewModel |
| dataPacketsNullable | Array<DataPacketViewModel> |
| designerViewNullable | any |
| updateCommentNullable | string |
| modelType | ViewModelModelType |
| incrementalEntitiesNullable | Array<IncrementalEntityViewModel> |
| calculatedExpressionsNullable | Array<CalculatedExpressionViewModel> |
| securityFilterConditionsNullable | Array<SecurityFilterConditionViewModel> |
| aiAssistantInfo | AIAssistantInfoViewModel |
!:AnalysisController.Load(LoadRequestViewModel)
| Name | Type |
|---|---|
| documentIdNullable | string |
M:GrapeCity.Enterprise.Server.AnalysisModel.AnalysisController.NameExist(GrapeCity.Enterprise.Server.AnalysisModel.ViewModels.ValidateNameRequestViewModel,GrapeCity.Enterprise.Storage.Facade.IStorageSession)
| Name | Type |
|---|---|
| nameNullable | string |
| idNullable | string |
!:AnalysisController.ValidateDataSources(ValidateDataSourcesRequestViewModel)
| Name | Type |
|---|---|
| documentIdNullable | string |