- 1 Locale options
- 2 Formatting
-
3 Headers
- 3.1 FormatTimeStampSettings
- 3.2 ConvertTargetTimeZone
- 3.3 FormatValueSettings
- 3.4 FormatLocale
Locale options
The ACRON REST API exposes several optional parameters for formatting time stamps, floating point numbers, etc. according to a custom locale as well as converting time stamps between time zones.
Formatting
When retrieving process data, properties that contain a time stamp or numeric value will also be provided as an additional property containing a formatted string.
By default formatting follows the presets defined in ACRON, although it may be customized using the provided headers.
Headers
The following Headers control time zone and formatting of the formatted alternate properties.
FormatTimeStampSettings
Sets format settings for time stamps, there being two possible options:
Culture
Format time stamp according to the culture identifier specified in the 'FormatLocale' Header.
If no 'FormatLocale' Header is provided, the locale of the server running the ACRON REST API will be used.
Acron
This setting is used by default. All time stamps will be formatted using the user defined presets in ACRON.
ConvertTargetTimeZone
Time zone identifier of time zone used for formatted time stamps. Valid time zone identifiers may be obtained by calling /api/acron/General/TimeZoneIDs.
If no 'ConvertTargetTimeZone' Header is provided, the local time zone of the server running the ACRON REST API will be used.
FormatValueSettings
Sets format settings for decimal values, there being two possible options:
Culture
Format decimal value according to the culture identifier specified in the 'FormatLocale' Header.
If no 'FormatLocale' Header is provided, the locale of the server running the ACRON REST API will be used.
Acron
This setting is used by default. All decimal values will be formatted using the user defined presets in ACRON.
FormatLocale
Culture identifier of locale used for formatting operations. Identifiers must follow the RFC 5646 definition, e.g. "de-DE", "en-US".