-
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
Language-Packages
Language-Packages
[GET] /api/v2/ui/common/language-packages
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| type | query | The package type to get. 1: Custom (default), 2: Official, 3: All |
Get language packages based on the specified type.
Responses
[200] Success
QueryLanguagePackagesResponseModel
Type: [application/json]
[400] Bad Request
Type: [application/json]
[POST] /api/v2/ui/common/language-packages
Create a new custom language package
Request Body
Description: The language package model
Type: application/json
Responses
[200] Success
Type: [application/json]
[400] Bad Request
Type: [application/json]
[DELETE] /api/v2/ui/common/language-packages/{packageId}
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| packageIdRequired | path | string | The package id to delete |
| forceDelete | query | boolean | Only use when you delete an official language package |
Delete the custom language package according to the specified package id.
Responses
[204] No Content
[400] Bad Request
Type: [application/json]
[404] Not Found
Type: [application/json]
[POST] /api/v2/ui/common/language-packages/upload
Request Body
Type: multipart/form-data
| Key | Type | Format | Encoding | Description |
|---|---|---|---|---|
| File | string | binary | form | The file to be uploaded as a language package. |
Responses
[200] Success
CustomLanguagePackageUploadModel
Type: [application/json]
[400] Bad Request
Type: [application/json]
[POST] /api/v2/ui/common/language-packages/commit/{displayName}/{sessionId}
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| displayNameRequired | path | string | The display name of the new custom language package |
| sessionIdRequired | path | string | The session id returned from the upload API |
Commit an upload session to create a new custom language package
Responses
[200] Success
Type: [application/json]
[400] Bad Request
Type: [application/json]
[404] Not Found
Type: [application/json]
[POST] /api/v2/ui/common/language-packages/import
Import a custom language package
Request Body
Type: multipart/form-data
| Key | Type | Format | Encoding | Description |
|---|---|---|---|---|
| File | string | binary | form | The file to be imported as a language package. |
Responses
[200] Success
CustomLanguagePackageUploadModel
Type: [application/json]
[400] Bad Request
Type: [application/json]
[POST] /api/v2/ui/common/language-packages/import/{sessionId}/submit
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| sessionIdRequired | path | string | The session id returned from the import API |
Submit an import session to create a new custom language package
Responses
[200] Success
Type: [application/json]
[400] Bad Request
Type: [application/json]
[404] Not Found
Type: [application/json]
[POST] /api/v2/ui/common/language-packages/{packageId}/migrate
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| packageIdRequired | path | string | custom language package id |
migrate the custom language package to the current production version
Responses
[204] No Content
[400] Bad Request
Type: [application/json]
[404] Not Found
Type: [application/json]
[POST] /api/v2/ui/common/language-packages/{packageId}/publish
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| packageIdRequired | path | string | package id |
publish draft
Responses
[204] No Content
[400] Bad Request
Type: [application/json]
[404] Not Found
Type: [application/json]
[GET] /api/v2/ui/common/language-packages/supported-cultures
get all supported cultures of the current server node
Responses
[200] Success
Type: [application/json]
[400] Bad Request
Type: [application/json]
[GET] /api/v2/ui/common/language-packages/{packageId}/download
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| packageIdRequired | path | string | the package id to download |
download some one language package (both official and custom)
Responses
[200] Success
binary
Type: [application/octet-stream]
[400] Bad Request
Type: [application/json]
[404] Not Found
Type: [application/json]
[POST] /api/v2/ui/common/language-packages/{packageId}/export
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| packageIdRequired | path | string | The package id |
Export the content of the language package
Request Body
Description: The export model
Type: application/json
Responses
[200] Success
binary
Type: [application/octet-stream]
[400] Bad Request
Type: [application/json]
[404] Not Found
Type: [application/json]
Models
Ƭ LanguagePackageType
Enum:
CustomOfficialAllRepresents the types of language packages available in the system.
*Custom- 0 - Indicates a custom language package created by the user.
*Official- 1 - Indicates an official language package provided by the system.
*All- 2 - Indicates all types of language packages, both custom and official.
Ƭ QueryLanguagePackagesResponseModel
Represents a response model for querying language packages.
| Name | Type | Description |
|---|---|---|
| languagePackagesNullable | Array<LanguagePackageViewModel> |
The list of language packages returned from the query. |
Ƭ LanguagePackageViewModel
Represents a language package view model containing details about a language package.
| Name | Type | Description |
|---|---|---|
| idNullable | string | Gets or sets the unique identifier of the language package. |
| languageCodeNullable | string | Gets or sets the language code of the language package. |
| nameNullable | string | Gets or sets the name of the language package. |
| displayNameNullable | string | Gets or sets the display name of the language package. |
| publishTime | ISO DateTime Sting | Gets or sets the publish time of the language package. |
| createdTime | ISO DateTime Sting | Gets or sets the created time of the language package. |
| modifiedTime | ISO DateTime Sting | Gets or sets the modified time of the language package. |
| versionNullable | string | Gets or sets the version of the language package. |
| productVersionNullable | string | Gets or sets the product version associated with the language package. |
| isOfficial | Boolean | Gets or sets a value indicating whether the language package is official. |
| isBuiltin | Boolean | Gets or sets a value indicating whether the custom language package is provided from official team. |
| published | Boolean | Gets or sets a value indicating whether the language package is published. |
| hasDraft | Boolean | Gets or sets a value indicating whether the language package has a draft. |
| hasMigrated | Boolean | Gets or sets a value indicating whether the language package has been migrated. |
| referenceLanguageNullable | string | Gets or sets the reference language of the language package. |
| uploadTime | ISO DateTime Sting | Gets or sets the upload time of the language package. |
| uploadByNullable | string | Gets or sets the user who uploaded the language package. |
Ƭ CLPErrorRequestResult
Custom language package error or warning response result
| Name | Type | Description |
|---|---|---|
| warningsNullable | Array<CLPWarning> |
warning of CLPErrorRequestResult |
| codeNullable | string | error code |
| messageNullable | string | error message |
| contextNullable | string | error context |
| innerError | ServerPluginError | |
| extensionsNullable | any | Extended result |
Ƭ CLPWarning
Represents a custom language package warning.
| Name | Type | Description |
|---|---|---|
| codeNullable | string | Warning code. |
| messageNullable | string | Warning message. |
| contextNullable | string |
Ƭ 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 |
Ƭ PackageResponseModel
Represents a response model for a package.
| Name | Type | Description |
|---|---|---|
| packageIdNullable | string | The unique identifier of the package. |
Ƭ LanguagePackagePostModel
Model used to create a custom language package.
| Name | Type | Description |
|---|---|---|
| displayNameRequired | string | Gets or sets the display name of the language package. |
| languageCodeRequired | string | Gets or sets the language code of the language package. |
| referenceLanguageRequired | string | The language code of the language package to be referenced. Attention: we will set the reference code of the created package to an official package. This property specifies which language package to copy the content from. |
Ƭ CustomLanguagePackageUploadModel
Represents a model for uploading a custom language package.
| Name | Type | Description |
|---|---|---|
| sessionIdNullable | string | Gets or sets the session identifier for the upload. |
| warningsNullable | Array<UploadWarning> |
Ƭ UploadWarning
Represents a warning during the upload process.
| Name | Type | Description |
|---|---|---|
| codeNullable | string | Gets or sets the warning code. |
| messageNullable | string | Gets or sets the warning message. |
Ƭ SupportCultureViewModel
Represents a view model for supported cultures.
| Name | Type | Description |
|---|---|---|
| codeNullable | string | Gets or sets the code of the culture. |
| nativeNameNullable | string | Gets or sets the native name of the culture. |
Ƭ ExportPostModel
Represents a model for export operations.
| Name | Type |
|---|---|
| type | ExportAndImportType |
| fileNamesNullable | Array<string> |
Ƭ ExportAndImportType
Enum:
EntirePartialUpgradationDiff