Dashboard

[POST] /api/dashboards/log

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

data

Responses

[200] Success

[POST] /api/dashboards

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

DashboardCreateViewModel

Responses

[200] Success

[PUT] /api/dashboards/{id}

Parameters

Name	In	Type
idRequired	path	string

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

DashboardEditViewModel

Responses

[200] Success

[DELETE] /api/dashboards/{id}

Parameters

Name	In	Type
idRequired	path	string

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string
rev	query	integer

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string
revRequired	path	integer

Responses

[200] Success

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

Parameters

Name	In	Type
pathRequired	path	string

Responses

[200] Success

[POST] /api/dashboards/map/geoData

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

MapGeoDataModel

Responses

[200] Success

[GET] /api/dashboards/map/folder

Parameters

Name	In	Type
folder	query	string

Responses

[200] Success

[GET] /api/dashboards/map/hierarchy

Parameters

Name	In	Type
hierarchy	query	string

Responses

[200] Success

[GET] /api/dashboards/map/mapTree

Responses

[200] Success

[POST] /api/dashboards/map/resetMapCache

Responses

[200] Success

[GET] /api/dashboards/map/download

Responses

[200] Success

binary

Type: [text/plain], [application/json], [text/json]

[POST] /api/dashboards/map/upload

Responses

[200] Success

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

Parameters

Name	In	Type
pathRequired	path	string

Responses

[200] Success

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

Parameters

Name	In	Type
pathRequired	path	string

Responses

[200] Success

[GET] /api/dashboards/config

Parameters

Name	In	Type
path	query	string

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string

Responses

[200] Success

[GET] /api/dashboards/contextInfo

Responses

[200] Success

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

Parameters

Name	In	Type
idRequired	path	string

Responses

[200] Success

[POST] /api/dashboards/industryIconSet/extract

Responses

[200] Success

[POST] /api/dashboards/industryIconSet

Request Body

Type: application/json-patch+json, application/json, text/json, application/*+json

IndustryIconSetViewModel

Responses

[200] Success

[DELETE] /api/dashboards/industryIconSet

Parameters

Name	In	Type
name	query	string

Responses

[200] Success

[GET] /api/dashboards/industryIconSets

Responses

[200] Success

Models

Ƭ DashboardCreateViewModel

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

Ƭ Content

Name	Type
docThemeNullable	any
filtersNullable	Array
imageListNullable	Array<DashboardImage>
languageResourceNullable	any

Ƭ Scenario

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

Ƭ DashboardPage

Name	Type
idNullable	string
contentNullable	any
optionsNullable	any

Ƭ SharedResource

Name	Type
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
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
• DataFile
• Spreadsheet
• Scene
• Glb
• DashboardTemplate
• VizTemplate
• IoT
• FilterView
• Notebook

Ƭ ValidValues

Name	Type	Description
datasetReference	DatasetReference
valuesNullable	Array<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	Array<LogicValue>	Gets the Logic values of default values.

Ƭ Binding

Name	Type
value	ParameterBindingValue
valueTypeNullable	string

Ƭ Transform

Name	Type
ruleNullable	string
directionNullable	string
unitNullable	string
formatterNullable	string

Ƭ DatasetReference

Name	Type
datasetIdNullable	string
valueFieldNullable	string
entityNameNullable	string
aggTypeNullable	string
sortBy	SortBy

Ƭ ParameterValue

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

Ƭ SortBy

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

Name	Type
order	int32
columnNullable	string

Ƭ LogicValue

Name	Type
valueTypeNullable	string
valueNullable	string
datasetReference	DatasetReference

Ƭ ParameterBindingValue

Name	Type
nameNullable	string
valuePropertyNameNullable	string
columnsNullable	Array<string>
checkedFieldNamesNullable	Array<string>

Ƭ DashboardEditViewModel

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

Ƭ MapGeoDataModel

Name	Type
level	MapLevel
conditionsNullable	Array<string>

Ƭ MapLevel

Enum:

• Country
• Province
• City
• District

Ƭ IndustryIconSetViewModel

Name	Type
nameNullable	string
iconsNullable	Array<IndustryIconViewModel>

Ƭ IndustryIconViewModel

Name	Type
nameNullable	string
contentNullable	string