-
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
Shared-Resources
Shared-Resources
[POST] /api/v2/shared-resources/language-resources/import-by-excel
Parameters
| Name | In | Type |
|---|---|---|
| docId | query | string |
Import language resource by excel
Request Body
Type: multipart/form-data
| Key | Type | Format | Encoding |
|---|---|---|---|
| File | string | binary | form |
Responses
[200] Success
Type: [application/json]
[400] Bad Request
Type: [application/json]
[GET] /api/v2/shared-resources/language-resources
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| docId | query | string | The document ID to filter language resources. If specified, only resources related to this document will be returned. Optional. Example: "doc123" |
| lngs | query | string | A comma-separated list of languages to filter the results. If specified, only resources for these languages will be returned. Optional. Example: "en,fr,es" |
| keys | query | string | A comma-separated list of keys to filter the language values. If specified, only values for these keys will be returned. Optional. Example: "key1,key2,key3" |
| organizationId | query | string | When the current user is a system administrator and this parameter has a value, the query will be based on the permissions of the specified organization rather than the system administrator's permissions. |
Retrieves language resource information based on specified criteria.
Responses
[200] Success
Type: [application/json]
[400] Bad Request
Type: [application/json]
[GET] /api/v2/shared-resources/web-pages/{id}
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| idRequired | path | string | The unique identifier of the web page, usually a GUID. Example: 123e4567-e89b-12d3-a456-426614174000 |
Queries information about a specific web page by its identifier.
Responses
[200] Success
Type: [application/json]
[400] Bad Request
Type: [application/json]
[404] Not Found
Type: [application/json]
[PUT] /api/v2/shared-resources/web-pages/{id}
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| idRequired | path | string | The unique identifier of the web page to update. |
Updates an existing web page in the system.
Request Body
Type: application/json
Responses
[204] No Content
[400] Bad Request
Type: [application/json]
[404] Not Found
Type: [application/json]
[POST] /api/v2/shared-resources/web-pages
Adds a new web page to the system.
Request Body
Description: The request model containing the details of the web page to add.
Type: application/json
Responses
[200] Success
Type: [application/json]
[400] Bad Request
Type: [application/json]
Models
Ƭ ImportLanguageResourceModel
Import language resource response model
| Name | Type | Description |
|---|---|---|
| idNullable | string | New language resource document Id |
Ƭ SharedResourcePluginError
| Name | Type | Description |
|---|---|---|
| codeNullable | string | error code |
| messageNullable | string | error message |
| contextNullable | string | error context |
| innerError | SharedResourcePluginError |
Ƭ LanguageVo
Represents a collection of language information, encapsulating details about multiple languages.
| Name | Type | Description |
|---|---|---|
| languagesInfoNullable | Array<LanguageInfo> |
A list of language information, each entry containing details about a specific language. |
Ƭ LanguageInfo
Represents detailed information about a specific language, including its identifier and associated language records.
| Name | Type | Description |
|---|---|---|
| idNullable | string | The unique identifier for the language. |
| languageRecordsNullable | Array<LanguageRecordInfo> |
A list of language records associated with this language. Each record contains localized text for a specific key. |
Ƭ LanguageRecordInfo
Represents a single language record, encapsulating a name and a list of values associated with it. This model is used to store and represent localized text values for a specific key within a language.
| Name | Type | Description |
|---|---|---|
| nameNullable | string | The name or key of the language record. This acts as an identifier for the localized text entries. |
| valuesNullable | Array<LanguageValueViewModel> |
A list of localized text values associated with this language record. Each entry in the list represents a localized value for a specific language, identified by a language code. |
Ƭ LanguageValueViewModel
Represents a view model for a language value. This model is used to encapsulate the key-value pair representation of a language-specific string, allowing for easy display and manipulation within UI components.
| Name | Type | Description |
|---|---|---|
| keyNullable | string | Gets the key of the language value. This key is typically used as an identifier for the specific string in a localization context. |
| valueNullable | string | Gets the localized string value associated with the key. This value is the actual text that will be displayed in the UI. |
Ƭ QueryWebPageInfoResponseModel
Represents the response model for a query operation that retrieves information about a web page.
| Name | Type | Description |
|---|---|---|
| idNullable | string | The unique identifier of the web page. |
| titleNullable | string | The title of the web page. |
| urlNullable | string | The URL of the web page. |
Ƭ UpdateWebPageRequestModel
| Name | Type |
|---|---|
| commentsNullable | string |
| urlNullable | string |
Ƭ AddWebPageResponseModel
Represents the response model for a web page addition operation.
| Name | Type | Description |
|---|---|---|
| documentIdNullable | string | The unique identifier of the added web page document. |
Ƭ AddWebPageRequestModel
| Name | Type |
|---|---|
| nameNullable | string |
| urlNullable | string |
| tagIdsNullable | Array<string> |
| commentsNullable | string |