messages_get

_{^{Public (authentication is not required)}}

Returns all translation messages for keys that are provided by the API and are therefore unknown to the client at build time.

For more information about translations and localization see i18n.

Note

Even when using Remote Access this method call is answered by the local device - the target attribute is ignored.

Params

attribute	description
language* 'en'	The code of the required language

Return

Returns a set of possibly nested objects mapping translation keys to the translations themselves.

The translation keys are in.dot.notation where the dot represents one step deeper into the hierarchy. So for example the translation key cars.ford.sedan would use the structure { cars: { ford: { sedan: "Ford sedan car" } } } to produce the translation Ford sedan car.

Dynamic data can be inserted into the translations via interpolation where placeholders defined as {{ placeholder_name }} will be replaced by respective values from a complementary translation params object. The translation params are typically passed from the API along the translation key.

If the translation param is to be translated itself, it must be specified as {{ $t(param_to_be_translated) }}. The param value is then interpreted as a translation key within the same top-level object (namespace).

attribute	description
alarm_overview* object	Translations of aggregated alarms Condensed Data
datasets* object	Datasets related translations
diagnostics_descriptions* object	Translations of diagnostics descriptions
errors* object	Translations of error messages
event_descriptions* object	Translations of event descriptions
monitoring_meta* object	Translations for monitoring configuration fields
monitoring_tree* object	Translations for monitoring configuration tree view
settings_meta* object	Translations for device configuration (settings) fields
settings_tree* object	Translations for device configuration (settings) tree view
statistics_types* object	Statistics related translations
status_info* object	Translations for the Status Info panels
status_overview* object	Translations for the Status Overview information
warnings* object	Translations of warning messages

Example

{
  …
  "diagnostics_descriptions": {
    "overview_stat": "Statistics ({{period_length_in_minutes}} min)"
  },
  "errors": {
    "general": {
      "operation_failed": "Operation failed."
      "operation_timeout": "Operation timed out after {{timeout}} seconds."
    }
    "system": {
      "errmsg_sys_syserror": "{{$t(general.operation_failed)}} System error.",
      "errmsg_sys_timeout": "{{$t(general.operation_timeout, { 'timeout': {{timeout}} })}}. Please try again."
    }
  },
  …
}