The Time Field stores a time value withing the property, 'value'.
{
"Start Time": {
"displayValue": "8:05 AM",
"value": "0000-01-01T12:34:20Z",
"id": "28b3af03-6ae2-4a1c-9b01-a46c0108d3c5",
"name": "Start Time_0",
"type": "Time"
}
}
NOTE:
The id, name, and type are not necessary when creating or updating a form, they are returned in the
JSONof a request for readability.
Value
The value property of the Date Field expects the date in the ISO 8601 format and more specifically in UTC.
The expected format takes the following form, YYYY-MM-DDThh:mm:ssZ, where:
| Format | Description |
|---|---|
| YYYY | A four-digit year, 0000 through 9999. |
| MM | A two-digit month of the year, 01 through 12. |
| DD | A two-digit day of that month, 01 through 31. |
| hh | Zero-padded hour between 00 and 23 |
| mm | A zero-padded minute between 00 and 59 |
| ss | A zero-padded second between 00 and 60 (where 60 is only used to denote an added leap second). |
The Time Field is only concerned with storing time values. To that end, in order to save times in the ISO 8601 format, set the YYYY-MM-DD of the format to 0000:01:01.
As an example, to set a TimeField to 1:30pm the following format would be used:
{
"value": "0000:01:01T13:30:00Z"
}
Display Value
The displayValue property of a Time Field is read-only. This means any change to this property will not be persisted after initially setting or updating a Time Field.
The displayValue property presents the value property as a formatted string which is defined by the template rules.