Date-Time no timezone type

Date-Time no timezone type documentation.

Overview

This type is capable of storing both date and time, but it doesn’t retain any timezone information. As a result, the date and time will appear identical regardless of the user’s viewing timezone. For instance, consider an events entity where you desire all users to view event date and time using the event’s local timezone; this type would ensure a consistent view for everyone.

The default format is yyyy-MM-dd HH:mm, yet you have the flexibility to customize it as needed.

Available features

NameSupported
Many multiplicityyes
Default valuesyes
Unique flagno
Required flagyes
Indexable flagyes
Sensitive flagyes
Calculated valueyes
Automatic initializationno
Calculated initial valueno
Aggregationno
Default type rulesno
Default display optionsyes

Display options

Representation

This defines the format for displaying the date and time. The default format is yyyy-MM-dd HH:mm, but you have the flexibility to customize it to suit your needs.

There exist several predefined formats that are commonly used. Additionally, you have the option to choose “Custom” and define a format according to the following rules:

  • 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)

Furthermore, you can also define a format for the date-time picker as needed.

REST API

Read format

The format is a string with the format yyyy-MM-dd HH:mm:

"eventDateTime": "2016-11-05 19:00"

Write format

You should pass a string in the format yyyy-MM-dd HH:mm:

"eventDateTime": "2016-11-05 19:00"

JavaScript API

Read format

The val() method in the wrapper will return a Date object.

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

Keep in mind that the Date object does have a timezone. The date and time will be set according to what’s stored in the field’s default timezone.

Write format

When writing the value, you can use either a Date object, a string with the format yyyy-MM-dd HH:mm, or milliseconds since the Epoch:

record.field('eventDateTime').val(new Date());
record.field('eventDateTime').val('2016-07-09 11:00');

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

Additionally, please keep in mind that when you use a Date object, the timezone information will be lost.

Wrapper Method:
format(pattern)

Formats the date-time to a string. If a format pattern is given, it will be used. Otherwise, the format set in the default display options of the field will be used.

Parameters
NameTypeRequiredDescription
patternstringnoThe pattern to format the date-time. Please check the documentation for display options to know which options are available for setting the format.
If no pattern is provided, the default display options of the field will be used.
Returns

string - The formatted date.

Exceptions

badRequest

If pattern 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 is yyyy-MM-dd HH:mm, regardless of the display options configured for that field.

"dateField1","dateField2"
"2017-05-14 13:20","2015-07-14 08:20"

Import format

The import format is yyyy-MM-dd HH:mm, regardless of the display options configured for that field.

"dateField1","dateField2"
"2017-05-14 13:20","2015-07-14 08:20"

Queries

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

Available operators

OperatorSupported
equalsyes
notEqualsyes
emptyyes
notEmptyyes
likeno
greateryes
greaterOrEqualsyes
lessyes
lessOrEqualsyes
betweenyes
currentUserFieldno

Query formats

You should pass a string with the format yyyy-MM-dd HH:mm. For example:

// finds companies with start date 2016-07-12 
var records_sample = sys.data.find('companies', {'eventDateTime': 'greater(2016-11-05 11:00)'});
log('total: '+records_sample.count());
while (records_sample.hasNext()) {
    log(records_sample.next().label());
}
// finds companies with start date 2016-07-12 
var query_sample = sys.data.createQuery('companies')
    .field('eventDateTime').greater('2016-11-05 11:00')
var records_sample = sys.data.find(query_sample);
log('total: '+records_sample.count());
while (records_sample.hasNext()) {
    log(records_sample.next().label());
}
// finds companies with start date 2016-07-12 
GET /data/contacts?eventDateTime=greater(2016-11-05 11:00)

When using the query builder, you can use a Date object or a string in the format 'yyyy-MM-dd HH:mm':

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

Aggregate queries

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

Available operators

OperatorSupported
sumno
avgno
firstyes
lastyes
minyes
maxyes

UI queries

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

Matching of values

PropertyDescription
Matching operatorequals
UI queries will attempt to match using the format specified in the default display options of the field.
Special valuesThere are some special values you can use:
- now: This translates to the current date and time, effectively representing the current moment.
- today: This denotes a range that encompasses the entirety of the present day.
- yesterday: This signifies a range that covers the entirety of the preceding day.
- tomorrow: This indicates a range that includes the entirety of the following day.
- last hour/day/week/month/year:These ranges include all instances from the last hour, day, week, month, or year, respectively.
- this hour/day/week/month/year:These ranges include all instances from the current hour, day, week, month, or year, respectively.
- last X hours/days/weeks/months/years:These ranges encompass all instances from the last X number of hours, days, weeks, months, or years.
- next X hours/days/weeks/months/years: These ranges encompass all instances from the next X number of hours, days, weeks, months, or years.

Available operators

OperatorSupported
Many valuesyes
Greaterno
Greater or equalsno
Lessyes
Less or equalsyes
Betweenyes