Analysis

[GET] /analytics/create

Response

Status Code: 200

Success

[GET] /analytics/edit/{id}

Parameters

Name	Type	Located In
id	string	query

Response

Status Code: 200

Success

[GET] /api/analysis/getcssurl

Parameters

Name	Type	Located In
cssName	string	query
theme	string	query

Response

Status Code: 200

Success

[GET] /api/analysis/getjsasseturlprefix

Response

Status Code: 200

Success

[GET] /api/analysis/customizeProperties

Response

Status Code: 200

Success

[GET] /api/analysis/organizationProperties

Response

Status Code: 200

Success

[POST] /api/analysis/cachemode/getdata

Request Schema

GetDataRequestViewModel

Response

Status Code: 200

Success

ModelingApiResponse

[GET] /api/analysis/cachemode/getdata/query/{queryId}

Parameters

Name	Type	Located In
queryIdRequired	string	path

Response

Status Code: 200

Success

ModelingApiResponse

[POST] /api/analysis/cachemode/heartbeat

Request Schema

HeartbeatRequestViewModel

Response

Status Code: 200

Success

ModelingApiResponse

[GET] /api/analysis/cachemode/defaultname

Response

Status Code: 200

Success

ModelingApiResponse

[POST] /api/analysis/cachemode/tables

Request Schema

ListMultipleDsTableNamesRequestViewModel

Response

Status Code: 200

Success

ModelingApiResponse

[POST] /api/analysis/cachemode/close

Request Schema

CloseRequestViewModel

Response

Status Code: 200

Success

ModelingApiResponse

[POST] /api/analysis/cachemode/entity/preview

Request Schema

PreviewEntityDataViewModel

Response

Status Code: 200

Success

ModelingApiResponse

[GET] /api/analysis/cachemode/lock/{modelDocId}

Parameters

Name	Type	Located In
modelDocIdRequired	string	path

Response

Status Code: 200

Success

ModelingApiResponse

[POST] /api/analysis/cachemode/relation/validate

Request Schema

ValidateRelationRequestViewModel

Response

Status Code: 200

Success

ModelingApiResponse

[POST] /api/analysis/cachemode/reload

Request Schema

ReloadRequestViewModel

Response

Status Code: 200

Success

ModelingApiResponse

[POST] /api/analysis/cachemode/reconfigure

Request Schema

ReconfigureRequestViewModel

Response

Status Code: 200

Success

ModelingApiResponse

[GET] /api/analysis/cachemode/reload/query/{queryId}

Parameters

Name	Type	Located In
queryIdRequired	string	path

Response

Status Code: 200

Success

ModelingApiResponse

[GET] /api/analysis/cachemode/getentitiesinfo/{docId}

Parameters

Name	Type	Located In
docIdRequired	string	path

Response

Status Code: 200

Success

ModelingApiResponse

[GET] /api/analysis/cachemode/getUsedEntities/{modelId}

Parameters

Name	Type	Located In
modelIdRequired	string	path

Response

Status Code: 200

Success

ModelingApiResponse

[GET] /api/analysis/cachemode/{docId}/entities

Parameters

Name	Type	Located In
docIdRequired	string	path

Response

Status Code: 200

Success

ModelingApiResponse

[POST] /api/analysis/cachemode/{docId}/reload

Parameters

Name	Type	Located In
docIdRequired	string	path

Request Schema

PortalReloadDataRequestViewModel

Response

Status Code: 200

Success

ModelingApiResponse

[POST] /api/analysis/cachemode/entity/validate

Request Schema

ValidateEntityBindingRequestViewModel

Response

Status Code: 200

Success

ModelingApiResponse

[POST] /api/analysis/cachemode/attribute/validate

Request Schema

ValidateAttributeBindingRequestViewModel

Response

Status Code: 200

Success

ModelingApiResponse

[POST] /api/analysis/cachemode/incrementalsetting/validate

Request Schema

ValidateIncrementalSettingRequestViewModel

Response

Status Code: 200

Success

ModelingApiResponse

[GET] /api/analysis/cachemode/cache/status

Parameters

Name	Type	Located In
pageSize	int32	query
pageNumber	int32	query
orderBy	string	query
search	string	query
invalid	Boolean	query

Response

Status Code: 200

Success

ModelingApiResponse

[POST] /api/analysis/connect

Tests connection with given connection string and provider.

Request Schema

TestConnectionRequestViewModel

Response

Status Code: 200

Success

ModelingApiResponse

[POST] /api/analysis/databases

Lists database names of given datasource.

Request Schema

ListDataBasesRequestViewModel

Response

Status Code: 200

Success

ModelingApiResponse

[POST] /api/analysis/tables

Lists table names of given datasource.

Request Schema

ListTableNamesRequestViewModel

Response

Status Code: 200

Success

ModelingApiResponse

[POST] /api/analysis/columns

Lists column names of given entity info.
The entity can be bound to physical database table or custom-SQL-table.

Request Schema

ListColumnNamesRequestViewModel

Response

Status Code: 200

Success

ModelingApiResponse

[POST] /api/analysis/autocreate

Detects entities and relations on given datasource to create an model.

Request Schema

AutoCreateModelRequestViewModel

Response

Status Code: 200

Success

ModelingApiResponse

[POST] /api/analysis/entity/validate

Validates the data binding of given entity info

Request Schema

ValidateEntityBindingRequestViewModel

Response

Status Code: 200

Success

ModelingApiResponse

[POST] /api/analysis/entity/parameter

Validates the data binding of given entity parameters

Request Schema

ValidateEntityBindingRequestViewModel

Response

Status Code: 200

Success

ModelingApiResponse

[POST] /api/analysis/attribute/validate

Validates the data binding of given attribute info

Request Schema

ValidateAttributeBindingRequestViewModel

Response

Status Code: 200

Success

ModelingApiResponse

[POST] /api/analysis/relation/validate

Validates the relation of given relation info

Request Schema

ValidateRelationRequestViewModel

Response

Status Code: 200

Success

ModelingApiResponse

[GET] /api/analysis/configuration

Response

Status Code: 200

Success

ModelingApiResponse

[POST] /api/analysis/localentity/getfiledata

Request Schema

DataSourceInfoViewModel

Response

Status Code: 200

Success

ModelingApiResponse

[POST] /api/analysis/localentity/validate

validate the data of local entity and complete attributes

Request Schema

ValidateLocalEntityDataRequestViewModel

Response

Status Code: 200

Success

ModelingApiResponse

[POST] /api/analysis/validate

Validates integrity of given model.

Request Schema

ValidateModelRequestViewModel

Response

Status Code: 200

Success

ModelingApiResponse

[POST] /api/analysis/save

Stores given model, designer view and datasource info into the storage.

Request Schema

SaveViewRequestModel

Response

Status Code: 200

Success

ModelingApiResponse

[POST] /api/analysis/update

Updates persisted document content with given model, designer view and datasource.

Request Schema

UpdateRequestViewModel

Response

Status Code: 200

Success

ModelingApiResponse

[POST] /api/analysis/load

Loads specified existing analysis-model-document.

Request Schema

LoadRequestViewModel

Response

Status Code: 200

Success

ModelingApiResponse

[POST] /api/analysis/entity/preview

Request Schema

PreviewEntityDataViewModel

Response

Status Code: 200

Success

ModelingApiResponse

[POST] /api/analysis/NameExist

Request Schema

ValidateNameRequestViewModel

Response

Status Code: 200

Success

boolean

[POST] /api/analysis/entity/parameters

Request Schema

datasourceId

Response

Status Code: 200

Success

ModelingApiResponse

[POST] /api/analysis/datasources/validate

Request Schema

ValidateDataSourcesRequestViewModel

Response

Status Code: 200

Success

ModelingApiResponse

Models

Ƭ ModelingApiResponse

Name	Type	Description	Example
succeeded	Boolean
errorCode	int32
errorDataDictNullable	string
resultNullable	any
innerError	InnerError

Ƭ InnerError

Name	Type	Description	Example
errorCode	int32
errorDataDictNullable	string
messageNullable	string
callStackNullable	string
inner	InnerError

Ƭ GetDataRequestViewModel

!:AnalysisController.GetData(GetDataRequestViewModel)

Name	Type	Description	Example
documentIdNullable	string
lockNoNullable	string
dataSourceInfo	DataSourceInfoViewModel
entitiesNullable	EntityViewModel

Ƭ DataSourceInfoViewModel

Name	Type	Description	Example
idNullable	string
type	DataSourceType
providerNullable	string
connectionStringNullable	string
documentIdNullable	string
documentVersionNullable	int32

Ƭ EntityViewModel

Name	Type	Description	Example
idNullable	string
nameNullable	string
bindingNullable	string
bindingType	ViewModelEntityBindingType
attributesNullable	AttributeViewModel
isHidden	Boolean
entityParameterCollection	EntityParameterCollectionViewModel
dataSourceIdNullable	string
generatedNameNullable	string
isSupportIncrementalUpdate	Boolean

Ƭ DataSourceType

Enum:

• Embedded
• Referenced

Ƭ ViewModelEntityBindingType

Enum:

• DatabaseTable
• CustomSQLTable
• LocalEntity

Ƭ AttributeViewModel

Name	Type	Description	Example
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

Ƭ EntityParameterCollectionViewModel

Name	Type	Description	Example
entityParametersNullable	EntityParameterViewModel

Ƭ ViewModelAttributeBindingType

Enum:

• DatabaseTableColumn
• PrimitiveSQLExpression

Ƭ ViewModelAttributeLogicalDataType

Enum:

• Number
• Text
• Boolean
• Binary
• GUID
• Date
• DateTime
• Unknown

Ƭ DataVizAIHint

Enum:

• None
• Currency
• ImageURL
• ImageBinary
• GeoRegion
• GeoLatitude
• GeoLongitude

Ƭ EntityParameterViewModel

Name	Type	Description	Example
parameterNameNullable	string
literalValueNullable	string
valueType	AttributeLogicalDataType
isMultivalued	Boolean

Ƭ AttributeLogicalDataType

Enum:

• Number
• Text
• Boolean
• Binary
• GUID
• Date
• DateTime
• Unknown

Ƭ HeartbeatRequestViewModel

!:AnalysisController.Heartbeat(HeartbeatRequestViewModel)

Name	Type	Description	Example
modelDocIdNullable	string
lockNoNullable	string

Ƭ ListMultipleDsTableNamesRequestViewModel

!:AnalysisController.ListMultiDsTableNames(ListTableNamesRequestViewModel)

Name	Type	Description	Example
dataSourceInfosNullable	DataSourceInfoViewModel

Ƭ CloseRequestViewModel

!:AnalysisController.Close(CloseRequestViewModel)

Name	Type	Description	Example
modelDocIdNullable	string
lockNoNullable	string

Ƭ PreviewEntityDataViewModel

Name	Type	Description	Example
documentIdNullable	string
dataSourceInfo	DataSourceInfoViewModel
previewEntity	PreviewEntityViewModel
filterCondition	PreviewSecurityFilterConditionViewModel
filterContextValuesNullable	PreviewSecurityFilterContextValue
rowLimitNullable	int32

Ƭ PreviewEntityViewModel

Name	Type	Description	Example
entityBinding	EntityBindingViewModel
attributeBindingsNullable	PreviewAttributeViewModel
entityParameterCollection	EntityParameterCollectionViewModel

Ƭ PreviewSecurityFilterConditionViewModel

Name	Type	Description	Example
leftType	EntityConditionRuleType
leftValueNullable	string
dataTypeNullable	string
operator	EntityConditionOperator
rightType	EntityConditionRuleType
rightValueNullable	string
type	EntityConditionType
itemsNullable	PreviewSecurityFilterConditionViewModel

Ƭ PreviewSecurityFilterContextValue

Name	Type	Description	Example
contextType	EntityConditionRuleType
contextNameNullable	string
contextValueNullable	Array
isMultipleValue	Boolean

Ƭ EntityBindingViewModel

Name	Type	Description	Example
idNullable	string
bindingType	ViewModelEntityBindingType
bindingNullable	string
tableNullable	string
schemaNullable	string

Ƭ PreviewAttributeViewModel

Name	Type	Description	Example
idNullable	string
nameNullable	string
bindingNullable	string
clrDataTypeNameNullable	string
dataType	ViewModelAttributeLogicalDataType
bindingType	ViewModelAttributeBindingType
isDate	Boolean

Ƭ EntityConditionRuleType

Enum:

• Attribute
• UserContext
• OrganizationContext
• Constant
• OtherEntityAttribute

Ƭ EntityConditionOperator

Enum:

• EqualTo
• NotEqualTo
• LessThan
• LessThanOrEqualTo
• GreaterThan
• GreaterThanOrEqualTo
• Is
• NotIs
• In
• NotIn
• Contains
• NotContains
• StartsWith
• NotStartsWith
• EndsWith
• NotEndsWith

Ƭ EntityConditionType

Enum:

• AndGroup
• OrGroup
• Rule

Ƭ ValidateRelationRequestViewModel

!:AnalysisController.ValidateRelation(ValidateRelationRequestViewModel)

Name	Type	Description	Example
documentIdNullable	string
dataSourceInfo	DataSourceInfoViewModel
relation	RelationViewModel
sourceEntity	EntityViewModel
targetEntity	EntityViewModel

Ƭ RelationViewModel

Name	Type	Description	Example
idNullable	string
nameNullable	string
type	ViewModelRelationType
sourceAttributesNullable	Array<string>
targetAttributesNullable	Array<string>
bidirectionCrossFiltering	Boolean
isInactive	Boolean

Ƭ ViewModelRelationType

Enum:

• OneToOne
• OneToMany
• OptionalOneToMany
• ManyToOne
• ManyToOptionalOne

Ƭ ReloadRequestViewModel

!:AnalysisController.ReloadData(ReloadRequestViewModel)

Name	Type	Description	Example
documentIdNullable	string
lockNoNullable	string
dataSourceInfosNullable	DataSourceInfoViewModel
entitiesNullable	EntityViewModel
incrementalEntitiesNullable	IncrementalEntityViewModel

Ƭ IncrementalEntityViewModel

Name	Type	Description	Example
entityIdNullable	string
attributeIdNullable	string

Ƭ ReconfigureRequestViewModel

Name	Type	Description	Example
documentIdNullable	string
lockNoNullable	string
dataSourceInfo	DataSourceInfoViewModel
entity	EntityViewModel

Ƭ PortalReloadDataRequestViewModel

Name	Type	Description	Example
entityIdsNullable	Array<string>
incrementalEntityIdsNullable	Array<string>

Ƭ ValidateEntityBindingRequestViewModel

!:AnalysisController.ValidateEntityBinding(ValidateEntityBindingRequestViewModel)

Name	Type	Description	Example
dataSourceInfo	DataSourceInfoViewModel
entityBinding	EntityBindingViewModel
modelType	ViewModelModelType

Ƭ ViewModelModelType

Enum:

• DirectQuery
• CacheMode

Ƭ ValidateAttributeBindingRequestViewModel

!:AnalysisController.ValidateAttributeBinding(ValidateAttributeBindingRequestViewModel)

Name	Type	Description	Example
dataSourceInfo	DataSourceInfoViewModel
attributeBinding	AttributeBindingViewModel
otherAttributeBindingsNullable	AttributeBindingViewModel
entityBinding	EntityBindingViewModel

Ƭ AttributeBindingViewModel

Name	Type	Description	Example
bindingType	ViewModelAttributeBindingType
bindingNullable	string
dataType	ViewModelAttributeLogicalDataType

Ƭ ValidateIncrementalSettingRequestViewModel

!:AnalysisController.ValidateIncrementalSetting(ValidateIncrementalSettingRequestViewModel)

Name	Type	Description	Example
dataSourceInfo	DataSourceInfoViewModel
attributeBinding	AttributeBindingViewModel
entityBinding	EntityBindingViewModel

Ƭ TestConnectionRequestViewModel

!:AnalysisController.TestConnection(TestConnectionRequestViewModel)

Name	Type	Description	Example
dataSourceInfo	DataSourceInfoViewModel

Ƭ ListDataBasesRequestViewModel

!:AnalysisController.ListDataBases(ListDataBasesRequestViewModel)

Name	Type	Description	Example
dataSourceInfo	DataSourceInfoViewModel

Ƭ ListTableNamesRequestViewModel

!:AnalysisController.ListTableNames(ListTableNamesRequestViewModel)

Name	Type	Description	Example
dataSourceInfo	DataSourceInfoViewModel

Ƭ ListColumnNamesRequestViewModel

!:AnalysisController.ListColumnNames(ListColumnNamesRequestViewModel)

Name	Type	Description	Example
dataSourceInfo	DataSourceInfoViewModel
entityBinding	EntityBindingViewModel

Ƭ AutoCreateModelRequestViewModel

!:AnalysisController.AutoCreateModel(AutoCreateModelRequestViewModel)

Name	Type	Description	Example
dataSourceInfo	DataSourceInfoViewModel
options	AutoCreateModelOptionsViewModel
modelType	ViewModelModelType

Ƭ AutoCreateModelOptionsViewModel

Name	Type	Description	Example
convertForeignKeysToRelations	Boolean
findRelatedTables	Boolean
notFilterUnsupported	Boolean
limitedTableNamesNullable	LimitedTableNameViewModel

Ƭ LimitedTableNameViewModel

Name	Type	Description	Example
schemaNullable	string
tableNullable	string

Ƭ ValidateLocalEntityDataRequestViewModel

Name	Type	Description	Example
entity	EntityViewModel
dataPacket	DataPacketViewModel
dataSourceInfo	DataSourceInfoViewModel

Ƭ DataPacketViewModel

Name	Type	Description	Example
idNullable	string
entityIdNullable	string
dataNullable	Array<array>
isZipCompressed	Boolean

Ƭ ValidateModelRequestViewModel

!:AnalysisController.ValidateModel(ValidateModelRequestViewModel)

Name	Type	Description	Example
dataSourceInfosNullable	DataSourceInfoViewModel
modelType	ViewModelModelType
model	ModelViewModel
validateOnDatabase	Boolean
incrementalEntitiesNullable	IncrementalEntityViewModel
calculatedExpressionsNullable	CalculatedExpressionViewModel
securityFilterConditionsNullable	SecurityFilterConditionViewModel

Ƭ ModelViewModel

Name	Type	Description	Example
entitiesNullable	EntityViewModel
relationsNullable	RelationViewModel
securityFiltersNullable	SecurityFilterViewModel

Ƭ CalculatedExpressionViewModel

Name	Type	Description	Example
entityIdNullable	string
nameNullable	string
dataType	AttributeLogicalDataType
expressionNullable	string
type	CalculatedExpressionType
dataVizAIHint	DataVizAIHint
isHidden	Boolean
isError	Boolean

Ƭ SecurityFilterConditionViewModel

Name	Type	Description	Example
entityIdNullable	string
condition	ConditionViewModel

Ƭ SecurityFilterViewModel

Name	Type	Description	Example
idNullable	string
nameNullable	string
sourceAttributeIdNullable	string
operator	ViewModelSecurityFilterOperator
contextPropertyNameNullable	string
contextType	ViewModelSecurityFilterContextType

Ƭ ViewModelSecurityFilterOperator

Enum:

• Equal
• In
• NotEqual
• NotIn

Ƭ ViewModelSecurityFilterContextType

Enum:

• UserContextProperty
• OrganizationContextProperty

Ƭ CalculatedExpressionType

Enum:

• Measure
• CalculatedColumn

Ƭ ConditionViewModel

Name	Type	Description	Example
leftType	EntityConditionRuleType
leftValueNullable	string
dataTypeNullable	string
operator	EntityConditionOperator
rightType	EntityConditionRuleType
rightValueNullable	string
type	EntityConditionType
itemsNullable	ConditionViewModel

Ƭ SaveViewRequestModel

!:AnalysisController.Save(SaveViewRequestModel)

Name	Type	Description	Example
dataSourceInfosNullable	DataSourceInfoViewModel
model	ModelViewModel
dataPacketsNullable	DataPacketViewModel
designerViewNullable	any
documentTitleNullable	string
saveCommentNullable	string
modelType	ViewModelModelType
incrementalEntitiesNullable	IncrementalEntityViewModel
calculatedExpressionsNullable	CalculatedExpressionViewModel
securityFilterConditionsNullable	SecurityFilterConditionViewModel

Ƭ UpdateRequestViewModel

!:AnalysisController.Update(UpdateRequestViewModel)

Name	Type	Description	Example
documentIdNullable	string
dataSourceInfosNullable	DataSourceInfoViewModel
model	ModelViewModel
dataPacketsNullable	DataPacketViewModel
designerViewNullable	any
updateCommentNullable	string
modelType	ViewModelModelType
incrementalEntitiesNullable	IncrementalEntityViewModel
calculatedExpressionsNullable	CalculatedExpressionViewModel
securityFilterConditionsNullable	SecurityFilterConditionViewModel

Ƭ LoadRequestViewModel

!:AnalysisController.Load(LoadRequestViewModel)

Name	Type	Description	Example
documentIdNullable	string

Ƭ ValidateNameRequestViewModel

M:GrapeCity.Enterprise.Server.AnalysisModel.AnalysisController.NameExist(GrapeCity.Enterprise.Server.AnalysisModel.ViewModels.ValidateNameRequestViewModel,GrapeCity.Enterprise.Storage.Facade.IStorageSession)

Name	Type	Description	Example
nameNullable	string
idNullable	string

Ƭ ValidateDataSourcesRequestViewModel

!:AnalysisController.ValidateDataSources(ValidateDataSourcesRequestViewModel)

Name	Type	Description	Example
documentIdNullable	string