Overview
This type can store an email, for example user@test.com
. This field will be rendered as a mailto
link.
Available features
Name | Supported | Notes |
---|---|---|
Many multiplicity |
yes |
|
Default values |
yes |
|
Unique flag |
yes |
|
Required flag |
yes |
|
Indexable flag |
yes |
|
Sensitive flag |
yes |
|
Calculated value |
yes |
|
Automatic initialization |
no |
|
Calculated initial value |
no |
|
Aggregation |
no |
|
Default type rules |
no |
|
Default display options |
no |
|
Type rules
Display options
REST API
Read format
The format is a simple string with the email:
"contactInformation": {
"email": "user@test.com"
}
Write format
You should pass a string with the email:
"contactInformation": {
"email": "user@test.com"
}
Javascript API
Read format
The val()
method in the wrapper will return a plain string with the email address:
// this will print something like "email: user@test.com"
log('email: '+record.field('contactInformation.email').val());
Write format
You should pass a plain string with the email to set the value:
record.field('contactInformation.email').val('user@test.com');
Wrapper
Export/Import
Export format
The export format is a simple string with the email:
"emailField1","emailField2"
"user1@test.com","user2@test.com"
Import format
The import format is a simple string with the email:
"emailField1","emailField2"
"user1@test.com","user2@test.com"
Queries
Please check the documentation for Query language for more information.
Available operators
Operator | Supported | Notes |
---|---|---|
equals |
yes |
|
notEquals |
yes |
|
empty |
yes |
|
notEmpty |
yes |
|
like |
yes |
|
greater |
yes |
|
greaterOrEquals |
yes |
|
less |
yes |
|
lessOrEquals |
yes |
|
between |
yes |
|
currentUserField |
no |
|
Query formats
You should pass the email as a plain string. For example:
// finds companies with contact email like 'test'
var records = sys.data.find('companies', {'contactInformation.email': 'like(test)'});
log('total: '+records.count());
while (records.hasNext()) {
log(records.next().label());
}
// finds companies with contact email like 'test'
var query = sys.data.createQuery('companies')
.field('contactInformation.email').like('test');
var records = sys.data.find(query);
log('total: '+records.count());
while (records.hasNext()) {
log(records.next().label());
}
finds companies with contact email like 'test'
GET /data/companies?contactInformation.email=like(test)
Aggregate queries
Please check the documentation for Aggregate queries for more information.
Available operators
Operator | Supported | Notes |
---|---|---|
sum |
no |
|
avg |
no |
|
first |
yes |
|
last |
yes |
|
min |
yes |
|
max |
yes |
|
UI queries
Please check the documentation for UI queries for more information.
Matching of values
Property | Description |
---|---|
Matching operator |
|
Special values |
Available operators
Operator | Supported | Notes |
---|---|---|
Many values |
yes |
|
Greater |
no |
|
Greater or equals |
no |
|
Less |
yes |
|
Less or equals |
yes |
|
Between |
no |
|