Mapped Localizations

GET /localization/map/{target}

devhttps://api.sandbox.ovok.com

Map a localization to a target language

All query parameters are FHIR query parameteters.

Parameters

Parameter Example	Description
category=key|home.about	Get all localizations for the key home.about
title:contains=About Page	Get all localizations where the value of the title contains About Page
_offset=0	Offset of the first localization
_count=10	Count of the localizations

NOTE: The provided language must be enabled in the system by calling Locale APIs.

Parameters

Name	In	Type	Required	Description
target	path	string	yes	Target locale code to map the project default language onto (e.g. de, fr). Must be enabled for the project and cannot equal the default language.
_count	query	string	no	Page size. Positive integer; defaults to 10.
_offset	query	string	no	Zero-indexed offset into the result set. Defaults to 0.
_sort	query	string	no	Sort key. Prefix with - for descending order. Defaults to -date (newest first).
search	query	string	no	Substring filter applied to the localization keys (case-insensitive).

Responses

Code	Description
200	Success.
400	The request could not be operated by the server.
401	The resource owner or authorization server denied the request.
404	The requested resource could not be found.
422	The request could not be validated by the server.
500	The server encountered an unexpected condition. Please try again later.

200 → PaginatedMapSearchResponseDto (application/json)

• total: number (required)
• resources: object[] (required)
  • source: object (required)
  • target: object