sourcePayloadTimeFormat

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

  • It applies to the tag's value only when the  "tagDataType" property is "time" or "timestamp".
  • The default value is "iso8601".
  • Use one of the following values (see "timeFormat"):
    • "hh.mm.ss.ttt"
    • "hh.mm.am/pm"
    • "hh.mm.ss.am/pm"
    • "hh.mm.ss"
    • "hh.mm"
    • "hhmm"
    • "iso8601"
    • "utc"
  • When combined with the "sourcePayloadDateFormat" property, the server can properly decode a date and time that can be stored in a timestamp field.
  • For example, "sourcePayloadTimeFormat":"iso8601" properly decodes "16:18:33" into a time that can be stored in a time field. 
  • 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, "sourcePayloadTimeFormat": "iso8601" causes a "jsonToTableFields" transform to read the value "18:01:47" from the tag's property in the source_payload field, decode it into the hour 18, minute 1, and second 47, and store it in the tag's time or timestamp field in the integration table.
  • For example, "sourcePayloadTimeFormat": "hh.mm.am/pm" causes a "jsonToTableFields" transform to read the value "06:01:47 pm" from the tag's property in the source_payload field, decode it into the hour 18, minute 1, and second 47, and store it in the tag's time or timestamp field in the integration table.
  • For example, "sourcePayloadTimeFormat": "hhmm" causes a "tableFieldsToJson" transform to read the hour 18, minute 1, and second 47 from the tag's time or timestamp field in the integration table, encode it into "1801", and store it the tag's property in the source_payload field.
  • When combined with the "sourcePayloadTimeFormat" property, the server can properly encode and decode a date and time stored in a timestamp field.