Date-Time type

Overview #

This type can store both date and time information.

The default format is yyyy-MM-dd HH:mm, but you can customize it to another format.

Available features #

Display options #

Representation #

This determines the format for displaying the date and time. The default format is yyyy-MM-dd HH:mm, but you can modify it according to your preferences.

You have the option to choose from several predefined formats that are commonly used. However, you can also opt for a Custom format and create your own pattern based on the following guidelines:

• Era designator: G (AD)
• Year: yy (16), yyyy (2016)
• Month: MMMM (July), MMM (Jul), MM (07)
• Week in year: w (27)
• Day in year: D (189)
• Day in month: d (9), dd (09)
• Day name in week: EEE (Tue), EEEE (Tuesday)
• Am/pm marker: a (PM)
• Hour in 24h: H (0), HH (00)
• Hour in am/pm: h (1), hh (01)
• Minute in hour: m (5), mm (05)
• Second in minute: s (9), ss(09)
• Millisecond: SSS (123)
• Time zone: z (-0700), zzzz (-07:00)

You also have the flexibility to define a format for the date-time picker to suit your needs.

REST API #

Read format #

The value of this type is represented as the number of milliseconds since the Epoch.

"lastUpdate": 1484578380000

Write format #

When writing the value for this type, you should provide the number of milliseconds since the Epoch.

"lastUpdate": 1484578380000

JavaScript API #

Read format #

When utilizing the val() method within the wrapper, it will yield a Date object.

// this will print something like "date: Mon Jan 16 2017 14:53:00 GMT-0000 (UTC)"
log('date: '+record.field('lastUpdate').val());

Write format #

When writing the value for this type, you have multiple options:

• You can use a Date object.
• You can use a string with the format yyyy-MM-dd HH:mm.
• You can provide the number of milliseconds since the Epoch.

record.field('startDate').val(new Date());
record.field('startDate').val('2016-07-09');

If the value provided is not valid, the field will be set to null silently.

Wrapper method:
toMillis() #

This method returns the date-time in milliseconds since the Unix Epoch.

Returns #

number - The time in milliseconds since the Unix Epoch

Samples #

// prints the time in milliseconds since the Unix Epoch

var company = sys.data.findOne('companies', {name: 'Blogpad'});
log('last update millis: '+company.field('lastUpdate').toMillis());

Wrapper method:
format(pattern, timeZoneId) #

This function is used to format the date-time into a string. If a format pattern and a time zone ID are provided, they will be applied. Alternatively, if no pattern or time zone ID is given, the default display options of the field will be utilized.

Parameters #

Returns #

string - The formatted date.

Exceptions #

badRequest

If pattern or timeZoneId is invalid

Samples #

// formats date using 'MM-dd-yyyy HH:mm' pattern
var company = sys.data.findOne('companies', {name: 'Blogpad'});
log('last update millis: '+company.field('lastUpdate').format('MM-dd-yyyy HH:mm'));

// formats date-time using default display options
var company = sys.data.findOne('companies', {name: 'Blogpad'});
log('last update millis: '+company.field('lastUpdate').format());

Export/Import #

Export format #

The export format for this field is yyyy-MM-dd'T'HH:mm:ss.SSS'Z'. The value is converted to UTC time for export, regardless of the display options set for that field.

"dateTimeField1","dateTimeField2"
"2017-05-14T13:20:01.014Z","2015-07-14T08:20:00.000Z"

The timezone for this field will always be UTC. Regardless of the display options or input values, the field will store and handle the date and time in Coordinated Universal Time (UTC).

Import format #

When importing data into this field, the expected format is yyyy-MM-dd'T'HH:mm:ss.SSS'Z'. This format represents the date and time in Coordinated Universal Time (UTC), regardless of the display options set for the field. The imported value will be converted to UTC time.

 "dateTimeField1","dateTimeField2"
 "2017-05-14T13:20:01.014Z","2015-07-14T08:20:00.000Z"

The timezone for this field will always be UTC. Regardless of the display options or input values, the field will store and handle the date and time in Coordinated Universal Time (UTC).

Queries #

For more information, please refer to the Query Language Documentation.

Available operators #

Query formats #

When working with queries, it’s essential to provide the time in milliseconds since the Unix Epoch.

// finds companies where last meeting is after '1458443760000' which is Sun Mar 20 2016 03:16:00 GMT-0000 (UTC) 
var records_sample = sys.data.find('companies', {'lastMeeting':'greater(1458443760000)'});
log('total: '+records_sample.count());
while (records_sample.hasNext()) {
    log(records_sample.next().label());
}

// finds companies where last meeting is after '1458443760000' which is Sun Mar 20 2016 03:16:00 GMT-0000 (UTC) 
var query_sample = sys.data.createQuery('companies')
    .field('lastMeeting').greater(1458443760000)
var records_sample = sys.data.find(query_sample);
log('total: '+records_sample.count());
while (records_sample.hasNext()) {
    log(records_sample.next().label());
}

// finds companies where last meeting is after '1458443760000' which is Sun Mar 20 2016 03:16:00 GMT-0000 (UTC) 
GET /data/contacts?lastMeeting=greater(1458443760000)

When utilizing the query builder, you have the option to use either a Date object or a string in the format ‘yyyy-MM-dd HH:mm’.

query.field('lastMeeting').less(new Date());
query.field('lastMeeting').less('2016-03-20 03:16');

Aggregate queries #

Please refer to the Aggregate Queries Documentation for more detailed information.

Available operators #

UI queries #

Please refer to the UI Queries Documentation for more detailed information.

Matching of values #

Available operators #