-
Interactive DashboardsCreate interactive BI dashboards with dynamic visuals.
-
End-User BI ReportsCreate and deploy enterprise BI reports for use in any vertical.
-
Wyn AlertsSet up always-on threshold notifications and alerts.
-
Localization SupportChange titles, labels, text explanations, and more.
-
Wyn ArchitectureA lightweight server offers flexible deployment.
-
Wyn Enterprise 7.1 is ReleasedThis release emphasizes Wyn document embedding and enhanced analytical express... -
Choosing an Embedded BI Solution for SaaS ProvidersAdding BI features to your applications will improve your products, better serve your customers, and more. But where to start? In this guide, we discuss the many options.
-
Visual GalleryInteractive sample dashboards and reports.
-
BlogExplore Wyn, BI trends, and more.
-
WebinarsDiscover live and on-demand webinars.
-
Customer SuccessVisualize operational efficiency and streamline manufacturing processes.
-
Knowledge BaseGet quick answers with articles and guides.
-
VideosVideo tutorials, trends and best practices.
-
WhitepapersDetailed reports on the latest trends in BI.
-
Choosing an Embedded BI Solution for SaaS ProvidersAdding BI features to your applications will impr... -
- v1
-
v2
- Admin
- ChatAnalysis
- ChatTokenUsage
- Common
- Custom-Themes
- Dashboard
- DashboardFilterView
- DataModel
- Dataset
- Datasource
- Documents
- DownloadSmartDocument
- Draft
- Identity
- Identity-Organization
- Identity-Role
- Identity-Token
- Identity-User
- K8s
- Language-Packages
- Languages
- Notebook
- QueueMonitor
- Reporting-CachingSettings
- Reporting-ExportTemplates
- Reporting-RenderResults
- Reporting-Reports
- Reporting-UserFunctions
- Scene
- Scheduler
- Shared-Resources
- SmartDocuments
- Tags
- overview
Custom-Themes
Custom-Themes
[GET] /api/v2/common/custom-themes
Retrieves a list of custom themes available for the user.
Responses
[200] Success
Type: [application/json]
[400] Bad Request
Type: [application/json]
[POST] /api/v2/common/custom-themes
Creates a new custom theme based on the provided model.
Request Body
Description: The request model containing theme details.
Type: application/json
Responses
[200] Success
CreateUpdateCustomThemeResponseModel
Type: [application/json]
[400] Bad Request
Type: [application/json]
[GET] /api/v2/common/custom-themes/status/{sessionId}
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| sessionIdRequired | path | string | The ID of the session to check the status for. |
Retrieves the status of a theme building session.
Responses
[200] Success
Type: [application/json]
[400] Bad Request
Type: [application/json]
[POST] /api/v2/common/custom-themes/{id}/upgrade
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| idRequired | path | string | The ID of the theme to upgrade. |
Upgrades a custom theme to a new version.
Responses
[200] Success
UpgradeCustomThemeResponseModel
Type: [application/json]
[400] Bad Request
Type: [application/json]
[404] Not Found
Type: [application/json]
[PUT] /api/v2/common/custom-themes/{id}
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| idRequired | path | string | The ID of the theme to save changes for. |
Saves changes to an existing custom theme.
Request Body
Description: The request model containing updated theme details.
Type: application/json
Responses
[200] Success
CreateUpdateCustomThemeResponseModel
Type: [application/json]
[400] Bad Request
Type: [application/json]
[404] Not Found
Type: [application/json]
[DELETE] /api/v2/common/custom-themes/{id}
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| idRequired | path | string | The unique identifier of the custom theme to be deleted. |
Deletes a custom theme identified by the specified ID.
This method checks if the theme exists and if it is currently in use before attempting to delete it.
Responses
[204] No Content
[400] Bad Request
Type: [application/json]
[404] Not Found
Type: [application/json]
Models
Ƭ CustomThemeViewModel
Represents the view model for custom themes.
| Name | Type | Description |
|---|---|---|
| listNullable | Array<CustomThemeItem> |
Gets or sets the list of custom theme items. |
| canEdit | Boolean | Gets or sets a value indicating whether the user can edit the theme. |
| hashProductionVersion | Boolean | Gets or sets a value indicating whether to hash the production version. |
| pluginStyleCacheDirectoryNullable | Array<string> |
Gets or sets the list of plugin style cache directories. |
Ƭ CustomThemeItem
Represents an individual custom theme item.
| Name | Type | Description |
|---|---|---|
| idNullable | string | Gets or sets the unique identifier of the theme. |
| created | ISO DateTime Sting | Gets or sets the creation date of the theme. |
| pluginVersionNullable | string | Gets or sets the plugin version associated with the theme. |
| displayNameNullable | string | Gets or sets the display name of the theme. |
| variables | ThemeVariablesViewModel | |
| outOfDate | Boolean | Gets or sets a value indicating whether the theme is out of date. |
Ƭ ThemeVariablesViewModel
Represents the view model for theme variables.
| Name | Type | Description |
|---|---|---|
| dark_theme | Boolean | Gets or initializes a value indicating whether the dark theme is enabled. |
| accent1Nullable | string | Gets or initializes the first accent color. |
| accent2Nullable | string | Gets or initializes the second accent color. |
| content_bgNullable | string | Gets or initializes the background color for content. |
| panels_bgNullable | string | Gets or initializes the background color for panels. |
| content_textNullable | string | Gets or initializes the text color for content. |
| text_contrastNullable | string | Gets or initializes the contrast color for text. |
| nav_bgNullable | string | Gets or initializes the background color for navigation. |
| nav_textNullable | string | Gets or initializes the text color for navigation. |
| portal_header_bgNullable | string | Gets or initializes the background color for the portal header. |
| portal_header_textNullable | string | Gets or initializes the text color for the portal header. |
| toolbar_bgNullable | string | Gets or initializes the background color for the toolbar. |
| toolbar_textNullable | string | Gets or initializes the text color for the toolbar. |
| toolbar_heightNullable | string | Gets or initializes the height of the toolbar. |
| portal | PortalVariablesViewModel |
Ƭ PortalVariablesViewModel
Represents the view model for portal theme variables.
| Name | Type | Description |
|---|---|---|
| advanced | Boolean | Whether to open the advanced settings. |
| primaryNav | PrimaryNavVariablesViewModel | |
| secondaryNav | SecondaryNavVariablesViewModel | |
| workspace | WorkspaceVariablesViewModel | |
| sidebar | SidebarVariablesViewModel |
Ƭ PrimaryNavVariablesViewModel
Represents the view model for primary navigation theme variables of portal.
| Name | Type | Description |
|---|---|---|
| portal_pri_nav_bgNullable | string | Gets or initializes the background color of the primary navigation. |
| portal_pri_nav_textNullable | string | Gets or initializes the foreground color of the primary navigation. |
| portal_pri_nav_bg_activeNullable | string | Gets or initializes the highlight background color of the primary navigation. |
| portal_pri_nav_text_activeNullable | string | Gets or initializes the highlight foreground color of the primary navigation. |
Ƭ SecondaryNavVariablesViewModel
Represents the view model for secondary navigation theme variables of portal.
| Name | Type | Description |
|---|---|---|
| portal_sec_nav_bgNullable | string | Gets or initializes the background color of the secondary navigation. |
| portal_sec_nav_textNullable | string | Gets or initializes the main foreground color of the secondary navigation. |
| portal_sec_nav_iconNullable | string | Gets or initializes the icon color of the secondary navigation. |
| portal_sec_nav_bg_activeNullable | string | Gets or initializes the highlight background color of the secondary navigation. |
| portal_sec_nav_text_activeNullable | string | Gets or initializes the main highlight foreground color of the secondary navigation. |
| portal_sec_nav_icon_activeNullable | string | Gets or initializes the highlight icon color of the secondary navigation. |
| portal_sec_nav_heading_textNullable | string | Gets or initializes the heading text color of the secondary navigation. |
Ƭ WorkspaceVariablesViewModel
Represents the view model for workspace theme variables of portal.
| Name | Type | Description |
|---|---|---|
| portal_ws_bgNullable | string | Gets or initializes the background color of the workspace. |
| portal_ws_textNullable | string | Gets or initializes the foreground color of the workspace. |
| portal_ws_bg_activeNullable | string | Gets or initializes the highlight background color of the workspace. |
| portal_ws_text_activeNullable | string | Gets or initializes the highlight foreground color of the workspace. |
| portal_ws_heading_textNullable | string | Gets or initializes the heading text color of the workspace. |
Ƭ SidebarVariablesViewModel
Represents the view model for sidebar theme variables of portal.
| Name | Type | Description |
|---|---|---|
| portal_sidebar_bgNullable | string | Gets or initializes the background color of the sidebar. |
| portal_sidebar_textNullable | string | Gets or initializes the foreground color of the sidebar. |
| portal_sidebar_text_activeNullable | string | Gets or initializes the highlight foreground color of the sidebar. |
| portal_sidebar_heading_textNullable | string | Gets or initializes the heading text color of the sidebar. |
Ƭ ServerPluginError
Server plugin error
| Name | Type | Description |
|---|---|---|
| codeNullable | string | error code |
| messageNullable | string | error message |
| contextNullable | string | error context |
| innerError | ServerPluginError | |
| extensionsNullable | any | Extended result |
Ƭ CreateUpdateCustomThemeResponseModel
Represents the response model for creating or updating a custom theme.
| Name | Type | Description |
|---|---|---|
| sessionIdNullable | string | Gets or sets the session identifier for the create/update operation. |
Ƭ CreateCustomThemeRequestModel
Represents the request model for creating a custom theme.
| Name | Type | Description |
|---|---|---|
| displayNameNullable | string | Gets or sets the display name of the custom theme. |
| variables | ThemeVariablesViewModel |
Ƭ ThemeBuilderStatusViewModel
Represents the view model for the status of the theme builder.
| Name | Type | Description |
|---|---|---|
| statusEnum | ThemeBuilderStatusEnumViewModel | |
| descriptionNullable | string | A description of the current status. |
| errorCodeNullable | string | An error code if the status is failed. |
| documentIdNullable | string | The document identifier associated with the theme. |
| progress | any | The progress percentage of the theme building process. |
Ƭ ThemeBuilderStatusEnumViewModel
Enum:
RUNNINGSUCCESSFAILEDRepresents the possible statuses of the theme builder.
*RUNNING- 0 - The theme builder is currently running.
*SUCCESS- 1 - The theme building process was successful.
*FAILED- 2 - The theme building process has failed.
Ƭ UpgradeCustomThemeResponseModel
Represents the response model for upgrading a custom theme.
| Name | Type | Description |
|---|---|---|
| versionNullable | string | Gets or sets the version of the upgraded theme. |
| sessionIdNullable | string | Gets or sets the session identifier for the upgrade. |
Ƭ SaveCustomThemeRequestModel
Represents the request model for saving a custom theme.
| Name | Type | Description |
|---|---|---|
| commentNullable | string | Gets or sets the comment associated with the custom theme. |
| variables | ThemeVariablesViewModel | |
| sessionIdNullable | string | Gets or sets the session identifier for the custom theme. |