Skip to content

[Back to Parameters]

Datetime

A widget used to select a date. Value is saved as a string representing a date. If no value is set, current date/time is implied.

Key Type Required Default Description UPM/TD
format enum:
datetime (yyyymmddHHMMSS),
date (yyyymmdd)
✔ datetime The format of the parameter value. ✔
milliseconds bool ❌ false If true append milliseconds in decimals. ✔
timeZone enum: local, utc ❌ local If utc, the date will be saved relative to UTC with +/-zz modifier. ✔
storageFormat enum: Fme, Iso ❌ Fme
Iso outputs strict ISO 8601 format.
(e.g., 2022-07-07T12:34:56)
Fme outputs FME format.
(e.g., 20220707123456)
Prefer Iso going forward.
❌1

Example

{
  "name": "somedate",
  "type": "datetime",
  "valueType": "string",
  "prompt": "Start date",
  "defaultValue": "20000101",
  "format": "date",
  "milliseconds": false,
  "timeZone": "local",
  "storageFormat": "Iso"
}

  1. Datetime parameters created in the UPM/TD use Iso format.