sourcePayloadBinaryFormat

The "sourcePayloadBinaryFormat" property is an optional enumerated string that specifies how the server encodes and decodes a binary value assigned to a tag. For example, it controls how a transform converts a binary value between a JSON property and a table field.

• It applies only when the "tagDataType" property is "binary".
• The default value is "hex".
• Use one of the following values:
  • "hex" - hexadecimal encoding.
  • "base64" - Base64 encoding.
  • "byteArray" - Array of integer values where each integer represents one byte.
• It applies to the tag's property in the source_payload field, which is specified by the "sourcePayloadPath" property.
• It applies to the tag's field in the integration table, which is specified by the "sourceFieldName" property.
• For example, "sourcePayloadBinaryFormat": "hex" causes a "jsonToTableFields" transform to read the value "BEEF" from the tag's property in the source_payload field, decode it into the binary value 0xBEEF, and store it in the tag's field in the integration table.
• For example, "sourcePayloadBinaryFormat": "byteArray" causes a "tableFieldsToJson" transform to read the value 0xBEEF from the tag's field in the integration table, encode it into a JSON array of bytes [190, 239], and store it the tag's property in the source_payload field.
• For example, "sourcePayloadBinaryFormat": "base64" causes a "tableFieldsToJson" transform to read the value 0xBEEF from the tag's field in the integration table, encode it into the Base64 value "vu8=", and store it the tag's property in the source_payload field.

For more details, see "binaryFormat".