Skip to main content

AdditionalPropertyValueType

Represents the supported data types for additional properties in HiiRetail.

Additional properties allow dynamic extension of entities with key-value pairs and metadata, supporting any data needs without requiring further development. The value is stored as a string, and the AdditionalPropertyValueType must be used to interpret and visualize the data correctly.

enum AdditionalPropertyValueType {
  BOOL
  INT
  LONG
  DECIMAL
  DOUBLE
  STRING
  DATE
  DATETIME
  CURRENCY
  IMAGE
  BINARY
  LINK
  ARRAY
  KEY_VALUE
  JSON
  XML
  TIME
  UNKNOWN
}

Values​

AdditionalPropertyValueType.BOOL​

Boolean value (true or false). Typically visualized as a checkbox.

AdditionalPropertyValueType.INT​

Signed 32-bit integer. Visualized as a numeric input without decimals.

AdditionalPropertyValueType.LONG​

Signed 64-bit integer. Visualized as a numeric input without decimals.

AdditionalPropertyValueType.DECIMAL​

Floating point number (double precision, ~15-17 digits). Visualized as a numeric input with decimals.

AdditionalPropertyValueType.DOUBLE​

Floating point number (decimal precision, 28-29 digits). Visualized as a numeric input with decimals.

AdditionalPropertyValueType.STRING​

Text input with no character restrictions.

AdditionalPropertyValueType.DATE​

Date input following ISO 8601 format (YYYY-MM-DD). Visualized as a date picker.

AdditionalPropertyValueType.DATETIME​

Date and time input following ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ). Visualized as a date-time picker.

AdditionalPropertyValueType.CURRENCY​

Numeric input with decimals, presented with currency information. May require additional metadata.

AdditionalPropertyValueType.IMAGE​

Text link to an image file. Only image file suffixes are allowed.

AdditionalPropertyValueType.BINARY​

Binary data stored externally (e.g., in cloud storage), referenced by a link.

URL to an external resource. Must be a valid link.

AdditionalPropertyValueType.ARRAY​

List of strings, separated by commas.

AdditionalPropertyValueType.KEY_VALUE​

Key-value pairs, separated by pipes (|), with keys and values separated by commas (,).

AdditionalPropertyValueType.JSON​

JSON structure. Validated for errors and visualized as formatted text.

AdditionalPropertyValueType.XML​

XML structure. Validated for errors and visualized as formatted text.

AdditionalPropertyValueType.TIME​

Time value following ISO 8601 formats. Not strictly validated. Examples: 23:20:30Z, 15:27:46, 232030Z.

AdditionalPropertyValueType.UNKNOWN​

Unknown type. Used for error handling or when the type cannot be determined.

Member Of​

AdditionalProperty object