Dataset

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

Download semantic model to a XML file.

Parameters

Name	Type	Located In	Description
documentIdRequired	string	path	The document id.

Response

Status Code: 200

Success

binary

[GET] /api/semantic/models

Lists all accessible semantic models.

Response

Status Code: 200

Success

SemanticViewModels+ModelInfo

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

Lists all entities in draft.

Parameters

Name	Type	Located In	Description
documentIdRequired	string	path	The document id.

Response

Status Code: 200

Success

SemanticViewModels+EntityInfo

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

Parameters

Name	Type	Located In	Description
documentIdRequired	string	path	The document id.

Response

Status Code: 200

Success

SemanticViewModels+Model

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

Parameters

Name	Type	Located In	Description
documentIdRequired	string	path	The document id.

Response

Status Code: 200

Success

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

Parameters

Name	Type	Located In	Description
documentIdRequired	string	path	The document id.

Request Schema

SemanticViewModels+EntityScopeRequest

Response

Status Code: 200

Success

SemanticViewModels+EntityScopeResponse

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

Reverts semantic model to specified older version.

Parameters

Name	Type	Located In	Description
modelIdRequired	string	path	The document id.
revisionRequired	int32	path	The version the semantic model is reverted to.

Response

Status Code: 200

Success

[GET] /api/v1/dataset/{id}/query

Get the preview data of the specified dataset document.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The document id.

Response

Status Code: 200

Success

binary

[POST] /api/v1/dataset/{id}/query

Parameters

Name	Type	Located In	Description
idRequired	string	path	The document id.

Response

Status Code: 200

Success

binary

[GET] /api/v1/datasource/{id}/query

Parameters

Name	Type	Located In	Description
idRequired	string	path	The document id.

Response

Status Code: 200

Success

binary

[POST] /api/v1/datasource/{id}/query

Parameters

Name	Type	Located In	Description
idRequired	string	path	The document id.

Response

Status Code: 200

Success

binary

[GET] /api/v1/datamodel/{id}/query

Get the preview data of the specified data model document.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The document id.

Response

Status Code: 200

Success

binary

[POST] /api/v1/datamodel/{id}/query

Parameters

Name	Type	Located In	Description
idRequired	string	path	The document id.

Response

Status Code: 200

Success

binary

[PUT] /api/datasetmanagement/batchRefreshCot

Refresh the COT data of the datasets.

Parameters

Name	Type	Located In	Description
overwrite	Boolean	query

Request Schema

BatchRefreshModel

Response

Status Code: 200

Success

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

Download the specified document.

Parameters

Name	Type	Located In	Description
param	string	query	The parameter.

Response

Status Code: 200

Success

binary

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

Parameters

Name	Type	Located In	Description
param	string	query	The parameter.

Response

Status Code: 200

Success

binary

[GET] /api/datasetmanagement/cots

Response

Status Code: 200

Success

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

Get the specified entity from the draft model.

Parameters

Name	Type	Located In	Description
idRequired	string	path	The document id.
entityIdRequired	string	path	The entity id.

Response

Status Code: 200

Success

SemanticViewModels+EntityEx

Models

Ƭ SemanticViewModels+ModelInfo

Name	Type	Description	Example
idNullable	string
titleNullable	string
effective_ops	Operations
revisionNo	int32
modelIdNullable	string
modelVersionNullable	string

Ƭ Operations

Enum:

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

Ƭ SemanticViewModels+EntityInfo

Name	Type	Description	Example
idNullable	string
nameNullable	string
hidden	Boolean

Ƭ SemanticViewModels+Model

Name	Type	Description	Example
entitiesNullable	SemanticViewModels+Entity

Ƭ SemanticViewModels+Entity

Name	Type	Description	Example
idNullable	string
nameNullable	string
hidden	Boolean
attributesNullable	SemanticViewModels+Attribute
relationsNullable	SemanticViewModels+Relation
parametersNullable	SemanticViewModels+ParameterForReport
defaultAggregateAttributesIdsNullable	Array<string>
defaultDetailAttributesIdsNullable	Array<string>
identifyingAttributesIdsNullable	Array<string>
descriptionNullable	string

Ƭ 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

Name	Type	Description	Example
valueNullable	string
labelNullable	string
isSpecial	Boolean

Ƭ EntityProcedureUiParameterValidValuesDomain

Enum:

• AnyValue
• FromTheDatabase
• FromAList

Ƭ EntityProcedureUiAtributeReference

Name	Type	Description	Example
nameNullable	string
pathNullable	string
valuesNullable	EntityProcedureUiParameterValue

Ƭ SemanticViewModels+EntityScopeResponse

Name	Type	Description	Example
entitiesNullable	SemanticViewModels+Entity
errorsNullable	Array<string>
scopesLoadedNullable	Array<string>

Ƭ SemanticViewModels+EntityScopeRequest

Name	Type	Description	Example
scopesNullable	SemanticViewModels+EntityScope
excludedIdsNullable	Array<string>

Ƭ SemanticViewModels+EntityScope

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

Ƭ BatchRefreshModel

Name	Type	Description	Example
refreshDataSetIdsNullable	Array<string>
cotSearchEntryInfosNullable	SearchEntryInfo

Ƭ SearchEntryInfo

Name	Type	Description	Example
tenantIdNullable	string
datasetIdNullable	string

Ƭ SemanticViewModels+EntityEx

Name	Type	Description	Example
attributesNullable	AttributeContract
relationsNullable	RelationContract
parametersNullable	SemanticViewModels+Parameter
id	string
nameNullable	string
descriptionNullable	string
procedureBindingNullable	string
bindingNullable	string
collectionNameNullable	string
queryNullable	string
hidden	Boolean
collapseInRelations	Boolean
securityFilter	SecurityFilterContract
defaultAggregateAttributesNullable	SemanticViewModels+SimpleAttributeContract
defaultDetailAttributesNullable	SemanticViewModels+SimpleAttributeContract
identifyingAttributesNullable	SemanticViewModels+SimpleAttributeContract

Ƭ AttributeContract

Name	Type	Description	Example
id	string
bindingNullable	string
dataType	DataType
logicalDataType	LogicalDataType
formatNullable	string
discourageGrouping	Boolean
hidden	Boolean
isAggregate	Boolean
nullable	Boolean
supportsBlank	Boolean
supportsNull	Boolean
valueSelection	ValueSelection
variationOfNullable	string
expressionNullable	string
variationsNullable	AttributeContract
expressionTextNullable	string
nameNullable	string
descriptionNullable	string

Ƭ RelationContract

Name	Type	Description	Example
id	string
bindingNullable	string
cardinality	Cardinality
isLogical	Boolean
hidden	Boolean
recursive	Boolean
includeSelf	Boolean
hiddenFieldsNullable	Array<string>
sourceEntityId	string
sourceColumnsNullable	Array<string>
targetEntityId	string
targetColumnsNullable	Array<string>
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