Skip to content

Entity Schema

Property Description Type Default
entity entity name string
entityPlural plural of the entity name string
key key name (should be Id)) array[string]
autogeneratedKey is the key autogenerated boolean false
ignoreOnUpdate array of properties that shouldn’t be updated array[string]
memberOf member of a group string
properties array of properties array[Property]

String property

Property Description Type Default
type string
nullable boolean false
maxLength
minLength
unicode boolean false
defaultValue

Integer property

Property Description Type Default
type integer
format int32
int64
nullable boolean false
maxValue integer
minValue integer
defaultValue integer

Number property

Property Description Type Default
type number
format float
double
decimal
precision
scale
nullable boolean false
maxValue
minValue
defaultValue

Guid property

Property Description Type Default
type uuid
nullable boolean false
defaultValue guid 00000000-0000-0000-0000-000000000000

DateTime property

Property Description Type Default
type date-time
format date-time
date-time-with-offset
date-only
time-only
date-time
nullable boolean false
supportTimeZone boolean false

Boolean property

Property Description Type Default
type integer
nullable boolean false
defaultValue integer

Binary property

Property Description Type Default
type binary
nullable boolean false
maxLength integer
Back to top