Entity data types

Data type

Type Description
Boolean data type The Boolean data type indicates the setting can only have values of true or false.
Condition attribute The condition attribute indicates that the setting is conditional on the value of another setting. When the condition is met then the action defined by the 'outcome' field is enforced.
Date data type The Date data type indicates the setting is the string representation of a Date. The value must be in the ISO 8601 format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'. Times are expressed in UTC (Coordinated Universal Time) using the special UTC designator ("Z"). Note that the "T" appears literally in the string, to indicate the beginning of the time element, as specified in ISO 8601
Entity definition An Entity Definition is the description of the Entity. It describes the properties, types, sizes, constraints, UI representations, etc.
Entity definitions A collection of supported entity definitions.
Entity instance An entity instance.
Entity instances A collection of entity instances.
Enum data type The Enum data type indicates a predefined list of constants that a setting can be set to.
Enum option The Enum option defines the attributes for each option in the Enum data type.
File data type The File data type indicates the setting takes the contents of a file. See:File Property. for required attributes when specifying a file setting in an entity instance.
File property The attributes of a File Property for an entity instance.
Integer data type The Integer data type indicates the setting can only be an integer.
Link data type The Link data type indicates that a setting is set to another entity instance. The 'fetchUrl' can be used to get all instances allowed to for the setting.
Long data type The Long data type indicates the setting can only be a long.
Ordered set data type The OrderedSet data type indicates the setting is a collection of elements. The 'collectionType' attribute indicates the data type of elements allowed in the collection. The order of the elements are maintained in the same order they are set.
Property data type Base entity definition data type.
Record data type The Record data type indicates that the setting is a collection of fields, possibly of different data types.
Stable set data type The StableSet data type indicates the setting is a collection of elements. The 'collectionType' attribute indicates the data type of elements allowed in the collection. The order of the elements are based on comparing the elements in the collection.
Text data type The Text data type indicates that the setting must be a String.
Time interval data type The Time interval data type indicates that the setting represents an interval of time (for example, 60 seconds). Specify the value in seconds. The value must be divisible by the value of the 'minUnit' field; for example, if the minUnit is 'min' (minutes), then 60 is a valid value, but 90 is not valid.