v8.0

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

Dashboard

[POST] /api/dashboards

Request Schema

DashboardViewModel

Response

Status Code: 200

Success

[PUT] /api/dashboards/{id}

Parameters

Name	Type	Located In
idRequired	string	path

Request Schema

DashboardViewModel

Response

Status Code: 200

Success

[DELETE] /api/dashboards/{id}

Parameters

Name	Type	Located In
idRequired	string	path

Response

Status Code: 200

Success

[GET] /api/dashboards/revert/{id}

Parameters

Name	Type	Located In
idRequired	string	path
rev	int32	query

Response

Status Code: 200

Success

[GET] /api/dashboards/{id}/{rev}

Parameters

Name	Type	Located In
idRequired	string	path
revRequired	int32	path

Response

Status Code: 200

Success

[GET] /api/dashboards/WebContents/{path}

Parameters

Name	Type	Located In
pathRequired	string	path

Response

Status Code: 200

Success

[POST] /api/dashboards/map/geoData

Request Schema

MapGeoDataModel

Response

Status Code: 200

Success

[GET] /api/dashboards/map/folder

Parameters

Name	Type	Located In
folder	string	query

Response

Status Code: 200

Success

[GET] /api/dashboards/map/hierarchy

Parameters

Name	Type	Located In
hierarchy	string	query

Response

Status Code: 200

Success

[GET] /api/dashboards/map/mapTree

Response

Status Code: 200

Success

[POST] /api/dashboards/map/resetMapCache

Response

Status Code: 200

Success

[GET] /api/dashboards/map/download

Response

Status Code: 200

Success

binary

[POST] /api/dashboards/map/upload

Response

Status Code: 200

Success

[GET] /api/dashboards/ModelFiles/{path}

Parameters

Name	Type	Located In
pathRequired	string	path

Response

Status Code: 200

Success

[GET] /api/dashboards/3DScene/EnvFiles/{path}

Parameters

Name	Type	Located In
pathRequired	string	path

Response

Status Code: 200

Success

[GET] /api/dashboards/config

Parameters

Name	Type	Located In
path	string	query

Response

Status Code: 200

Success

[GET] /api/dashboards/{id}/download

Parameters

Name	Type	Located In
idRequired	string	path

Response

Status Code: 200

Success

[GET] /api/dashboards/contextInfo

Response

Status Code: 200

Success

[POST] /api/dashboards/addPreviewLog/{id}

Parameters

Name	Type	Located In
idRequired	string	path

Response

Status Code: 200

Success

[POST] /api/dashboards/industryIconSet/extract

Response

Status Code: 200

Success

[POST] /api/dashboards/industryIconSet

Request Schema

IndustryIconSetViewModel

Response

Status Code: 200

Success

[DELETE] /api/dashboards/industryIconSet

Parameters

Name	Type	Located In
name	string	query

Response

Status Code: 200

Success

[GET] /api/dashboards/industryIconSets

Response

Status Code: 200

Success

Models

Ƭ DashboardViewModel

Name	Type	Description	Example
idNullable	string
titleNullable	string
content	Content
optionsNullable	any
scenariosNullable	Scenario
pagesNullable	DashboardPage
sharedResourcesNullable	SharedResource
versionNullable	string
datasetProfilesNullable	any
tagIdsNullable	`Array<string>`
commentNullable	string
parametersNullable	DashboardParameter

Ƭ Content

Name	Type	Description	Example
docThemeNullable	any
filtersNullable	`Array`
imageListNullable	DashboardImage
languageResourceNullable	any

Ƭ Scenario

Name	Type	Description	Example
idNullable	string
contentNullable	any
optionsNullable	any
pageIdNullable	string
nameNullable	string

Ƭ DashboardPage

Name	Type	Description	Example
idNullable	string
contentNullable	any
optionsNullable	any

Ƭ SharedResource

Name	Type	Description	Example
idNullable	string
type	DocumentType

Ƭ DashboardParameter

Name	Type	Description
nameNullable	string	Name of the parameter.
promptNullable	string	The text to display to a user when prompting the a for the parameter's value.
dataTypeNullable	string	The data type of the parameter.
outputDataTypeNullable	string
dateOnly	Boolean
multiValue	Boolean
multiline	Boolean
hidden	Boolean
allowBlank	Boolean
validValues	ValidValues
defaultValue	DefaultValue
binding	Binding
transform	Transform
valueTypeNullable	string

Ƭ DashboardImage

Name	Type	Description	Example
idNullable	string
nameNullable	string
srcNullable	string
size	int32
typeNullable	string
dashboardIdNullable	string

Ƭ DocumentType

Enum:

Unknown
Dashboard
Dataset
DataSource
Image
Theme
MapHierarchy
GeoJson
Report
Visual
FloorPlan
AnalysisModel
Font
LanguageResource
NativeQuery
Scene
Glb
DashboardTemplate
VizTemplate
IoT

Ƭ ValidValues

Name	Type	Description	Example
datasetReference	DatasetReference
valuesNullable	ParameterValue	Gets the list of possible values for the parameter.

Ƭ DefaultValue

Name	Type	Description
datasetReference	DatasetReference
valuesNullable	`Array<string>`	Gets the default values for the parameter.
logicValuesNullable	LogicValue	Gets the Logic values of default values.

Ƭ Binding

Name	Type	Description	Example
value	ParameterBindingValue
valueTypeNullable	string

Ƭ Transform

Name	Type	Description	Example
ruleNullable	string
directionNullable	string
unitNullable	string
formatterNullable	string

Ƭ DatasetReference

Representing the query to execute to obtain the default value(s) for the parameter.

Name	Type	Description	Example
datasetIdNullable	string
valueFieldNullable	string
entityNameNullable	string
aggTypeNullable	string

Ƭ ParameterValue

Name	Type	Description	Example
labelNullable	string	Label for the value to display in a UI
valueNullable	string	Specifies a value for a parameter.

Ƭ LogicValue

Name	Type	Description	Example
valueTypeNullable	string
valueNullable	string
datasetReference	DatasetReference

Ƭ ParameterBindingValue

Name	Type	Description	Example
nameNullable	string
valuePropertyNameNullable	string
columnsNullable	`Array<string>`
checkedFieldNamesNullable	`Array<string>`

Ƭ MapGeoDataModel

Name	Type	Description	Example
level	MapLevel
conditionsNullable	`Array<string>`

Ƭ MapLevel

Enum:

Country
Province
City
District

Ƭ IndustryIconSetViewModel

Name	Type	Description	Example
nameNullable	string
iconsNullable	IndustryIconViewModel

Ƭ IndustryIconViewModel

Name	Type	Description	Example
nameNullable	string
contentNullable	string