Shared-Resources
Shared-Resources
[POST] /api/v2/shared-resources/language-resources/import-by-excel
Import language resource by excel
Parameters
| Name | Type | Located In |
|---|---|---|
| docId | string | query |
Response
Status Code: 200
Success
Status Code: 400
Bad Request
[GET] /api/v2/shared-resources/language-resources
Retrieves language resource information based on specified criteria.
Parameters
| Name | Type | Located In | Description |
|---|---|---|---|
| docId | string | query | The document ID to filter language resources. If specified, only resources related to this document will be returned. Optional. Example: "doc123" |
| lngs | string | query | 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 | string | query | 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 | string | query |
Response
Status Code: 200
Success
Status Code: 400
Bad Request
[GET] /api/v2/shared-resources/web-pages/{id}
Queries information about a specific web page by its identifier.
Parameters
| Name | Type | Located In | Description |
|---|---|---|---|
| idRequired | string | path | The unique identifier of the web page, usually a GUID. Example: 123e4567-e89b-12d3-a456-426614174000 |
Response
Status Code: 200
Success
Status Code: 400
Bad Request
Status Code: 404
Not Found
[PUT] /api/v2/shared-resources/web-pages/{id}
Updates an existing web page in the system.
Parameters
| Name | Type | Located In | Description |
|---|---|---|---|
| idRequired | string | path | The unique identifier of the web page to update. |
Request Schema
Response
Status Code: 204
No Content
Status Code: 400
Bad Request
Status Code: 404
Not Found
[POST] /api/v2/shared-resources/web-pages
Adds a new web page to the system.
Request Schema
Response
Status Code: 200
Success
Status Code: 400
Bad Request
Models
Ƭ ImportLanguageResourceModel
Import language resource response model
| Name | Type | Description | Example |
|---|---|---|---|
| idNullable | string | New language resource document Id |
Ƭ SharedResourcePluginError
| Name | Type | Description | Example |
|---|---|---|---|
| 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 | Example |
|---|---|---|---|
| languagesInfoNullable | 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 | Example |
|---|---|---|---|
| idNullable | string | The unique identifier for the language. | |
| languageRecordsNullable | 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 | Example |
|---|---|---|---|
| nameNullable | string | The name or key of the language record. This acts as an identifier for the localized text entries. | |
| valuesNullable | 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 | Example |
|---|---|---|---|
| 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 | Example |
|---|---|---|---|
| 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 | Description | Example |
|---|---|---|---|
| commentsNullable | string | ||
| urlNullable | string |
Ƭ AddWebPageResponseModel
Represents the response model for a web page addition operation.
| Name | Type | Description | Example |
|---|---|---|---|
| documentIdNullable | string | The unique identifier of the added web page document. |
Ƭ AddWebPageRequestModel
| Name | Type | Description | Example |
|---|---|---|---|
| nameNullable | string | ||
| urlNullable | string | ||
| tagIdsNullable | Array<string> |
||
| commentsNullable | string |