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

SharedResources

[GET] /api/resources/image/{id}

Parameters

Name	Type	Located In
idRequired	string	path

Response

Status Code: 200

Success

[GET] /images/view/{id}

Parameters

Name	Type	Located In
idRequired	string	path

Response

Status Code: 200

Success

[GET] /api/resources/theme/{id}

Parameters

Name	Type	Located In
idRequired	string	path

Response

Status Code: 200

Success

[GET] /theme/view/{id}

Parameters

Name	Type	Located In
idRequired	string	path

Response

Status Code: 200

Success

[GET] /api/resources/theme/preview/{id}

Parameters

Name	Type	Located In
idRequired	string	path

Response

Status Code: 200

Success

Theme

[GET] /api/resources/getjsasseturlprefix

Response

Status Code: 200

Success

[POST] /api/resources/theme

Request Schema

ThemeViewModel

Response

Status Code: 200

Success

[PUT] /api/resources/theme

Request Schema

ThemeViewModel

Response

Status Code: 200

Success

[GET] /api/resources/visual/{id}

Parameters

Name	Type	Located In
idRequired	string	path

Response

Status Code: 200

Success

[POST] /api/resources/visual/{id}

Parameters

Name	Type	Located In
idRequired	string	path

Request Schema

SharedResourcesController+VisualViewModel

Response

Status Code: 200

Success

[GET] /api/resources/visuals

Response

Status Code: 200

Success

SharedResourcesController+VisualInfoViewModel

[POST] /api/resources/floorPlan

Request Schema

FloorPlanViewModel

Response

Status Code: 200

Success

[PUT] /api/resources/floorPlan

Request Schema

FloorPlanViewModel

Response

Status Code: 200

Success

[GET] /api/resources/floorPlan/{id}/{isPreview}

Parameters

Name	Type	Located In
idRequired	string	path
isPreviewRequired	Boolean	path

Response

Status Code: 200

Success

[POST] /api/resources/font

Request Schema

FontViewModel

Response

Status Code: 200

Success

[PUT] /api/resources/font

Request Schema

FontViewModel

Response

Status Code: 200

Success

[GET] /api/resources/fonts/{fontId}

Parameters

Name	Type	Located In
fontId	string	query

Response

Status Code: 200

Success

binary

[GET] /api/sharedResource/getcssurl

Parameters

Name	Type	Located In
cssName	string	query
theme	string	query

Response

Status Code: 200

Success

Models

Ƭ Theme

Name	Type	Description	Example
accent1Nullable	string
accent2Nullable	string
accent3Nullable	string
accent4Nullable	string
accent5Nullable	string
accent6Nullable	string
dark1Nullable	string
dark2Nullable	string
light1Nullable	string
light2Nullable	string
hyperlinkNullable	string
hyperlinkFollowedNullable	string
scrollbarThumbNullable	string
scrollbarTrackNullable	string
majorFontFamilyNullable	string
minorFontFamilyNullable	string
majorFontStyleNullable	string
minorFontStyleNullable	string
majorFontSizeNullable	string
minorFontSizeNullable	string
majorFontWeightNullable	string
minorFontWeightNullable	string
majorFontNameNullable	string
minorFontNameNullable	string

Ƭ ThemeViewModel

Name	Type	Description	Example
idNullable	string
titleNullable	string
commentNullable	string
info	Theme

Ƭ SharedResourcesController+VisualViewModel

Name	Type	Description	Example
idNullable	string
status	CVLicenseValidateStatus
contentNullable	any
configurationNullable	string
contextNullable	string

Ƭ CVLicenseValidateStatus

Enum:

NoLicense
Trial
TrialExpired
Licensed

Ƭ SharedResourcesController+VisualInfoViewModel

Name	Type	Description	Example
documentIdNullable	string
info	Visual
titleNullable	string

Ƭ Visual

Name	Type	Description
documentIdNullable	string
visualIdNullable	string
visualVersionNullable	string
nameNullable	string
displayNameNullable	string
iconNullable	string	Storage the resource URL
iconCssNullable	string
configurationNullable	string
visualTypeNullable	string
certifiedNullable	Boolean
authRequiredNullable	Boolean

Ƭ FloorPlanViewModel

Name	Type	Description	Example
idNullable	string
titleNullable	string
commentNullable	string
infoNullable	any
displayNameNullable	string

Ƭ FontViewModel

Name	Type	Description	Example
idNullable	string
titleNullable	string
commentNullable	string
fontTypeNullable	string
urlNullable	string
localFontDataNullable	string
extNullable	string
tagIdsNullable	`Array<string>`