close anchor

Element

The element data object.

Data Fields

Field Type Description
id string The UUID of the element for which data is being provided.
date_time object The init and edit date/time this entry was initially posted, and that of its latest known edit or update, both provided in ISO 8601 format.
type string The element type, being of those provided by the /element/types endpoint.
enabled boolean Indicates whether or not the element is enabled. This provides for an expression to filter the elements to be publicly displayed.
optional boolean Indicates whether the element is to be treated as optional in terms of whether a non-empty value is expected before an entry would qualify for publication by an editor.
name string The name of the element, provided in the endpoint transaction or fallback locale (if plural, this will be delivered in an object keyed by each).
description string The textual description for this element, provided in the endpoint transaction or fallback locale (if plural, this will be delivered in an object keyed by each).
groups object The group(s) in which this element is present, including both element and user groups. If provided by the /content endpoint (being an element identified with a content entry), only the group id will be included for each.
types array The content type(s) identified with this element, being a one-dimensional indexed array in which each value is the UUID of an individual content type.
preferences object The preferences defined for this element, based in part on its type (further information below).
attributes object If defined, the entity-attribute-value data identified with this entity.
data -- If provided by the /content endpoint (being an element identified with a content entry), this property will include the element's value(s) for that entry. The data type of this value is dependent upon the element type, on which further explanation is provided below.

The type declared for an element determines both the type-based preferences and the different kinds of values that potentially exist for that element.

Boolean

No element preferences unique to the boolean type exist. If data is provided for the element, it will be delivered as a true or false value, or null.

Contact

The preferences for a contact-type element include:

Field Type Description
quantity array of integers The preferred quantity of values for this element (low - high), in which 0 = ∞ (if a zero value, no threshold or limit is enforced for it).

The data provided for an element of this type will be a one-dimensional array of contact object(s) including their id, name, email.

Content

The preferences for a content-type element include:

Field Type Description
quantity array of integers The preferred quantity of values for this element (low - high), in which 0 = ∞ (if a zero value, no threshold or limit is enforced for it).
types array The type(s) of content entry permitted for the element, being a one-dimensional array in which each value is the UUID of an individual content type. If no type(s) indicated, entries will not be excluded by content type.

The data provided for an element of this type will be a one-dimensional array of content object(s) including their id, title, phase.

Date/Time

The preferences for a datetime element include:

Field Type Description
data_type string Indicates whether the element is intended to provide for a date, time or (if empty) both date/time + zone.
interval boolean If true, this element provides for a begin - end date/time value. This is useful in describing events, for instance, in which the user is enabled to indicate the duration thereof with one element value instead of two, if desired.
quantity array of integers The preferred quantity of values for this element (low - high), in which 0 = ∞ (if a zero value, no threshold or limit is enforced for it).

The data provided for an element of this type will depend on these preferences in that a date, time or date/time + zone will of course differ; but each is to be provided in an Elebase-known (for this purpose) ISO 8601 format:

Data Type Example(s)
date/time + zone 2017-01-10T10:00:00+00:00
2017-01-10T10:00:00.000Z
date 2017-01-10
time 01:00
01:00:00

Independent of both the quantity of values that exist and whether or not each provides for an interval or duration, the data for an element of this kind will be delivered as a two-dimensional array in which the parent dimension includes a variable quantity of inner arrays each providing 1-2 value(s) based on whether or not each provides a begin - end date/time interval.

Embed

The preferences for an embed-type element include:

Field Type Description
quantity array of integers The preferred quantity of values for this element (low - high), in which 0 = ∞ (if a zero value, no threshold or limit is enforced for it).

The data provided for an element of this type will be a one-dimensional array of embed object(s).

File

The preferences for a file-type element include:

Field Type Description
file_type_group string Identifies a predefined group of file types to be used with this element.
quantity array of integers The preferred quantity of values for this element (low - high), in which 0 = ∞ (if a zero value, no threshold or limit is enforced for it).

The data provided for an element of this type will be a one-dimensional array of file object(s).

Geo

The preferences for a geo-type element include:

Field Type Description
point string The default geographic point location for this element, provided as a comma-delimited textual value indicating both longitude and latitude, in that order.
user_geo_layer boolean Indicates whether or not a privileged user will be enabled to provide a non-default base layer to use for this element. If true, a data entry UI ought to provide an input technique for the user to enter an Esri web map ID that would then be presented to users entering values for this element as a geo layer, for instance.
zoom integer The preferred default zoom level for this element.

The geo-type element incorporates layers and feature types extending beyond these preferences, too, delivered in the geo object, unique to this element type and including both:

Field Type Description
layers array The geo layer(s) enabled for this element, being a one-dimensional array of geo layer object(s) and including an ordinal for each to indicate the desired position of the geo layer for this element.
feature object This includes a property for types, being a one-dimensional array of geo feature type object(s).

The data provided for an element of this type will be a geo data object.

ID

The preferences for an id-type element include:

Field Type Description
length array of integers The desired length of the textual value for this element (low - high), in which 0 = ∞ (if a zero value, no threshold or limit is enforced for it).
unique boolean If true, identical or duplicate values will not be permitted for this element, thereby enforcing uniqueness of each value throughout the project.

The data provided for an element of this type will be either null (if no value exists) or a textual value (not identified with a locale).

Integer/Numeric

The preferences for an intnum-type element include:

Field Type Description
integer boolean If true, only integer values will be permitted for this element.

The data provided for an element of this type will be either null (if no value exists) or an integer/numeric string value.

Option

The preferences for an option-type element include:

Field Type Description
quantity array of integers The preferred quantity of values for this element (low - high), in which 0 = ∞ (if a zero value, no threshold or limit is enforced for it).

If defined, an indexed array of element options will be provided in which each value is an object, the properties of which include:

Field Type Description
id string The UUID of the element option.
text string The element option text, provided in the endpoint transaction or fallback locale (if plural, this will be delivered in an object keyed by each).
ordinal integer The desired position of the element option (if being displayed in a pull-down, for instance), either on the top level or in a parent option if defined.
options array If not being provided by the /content endpoint, the element option(s) of which this option is the parent, in which each value is an object including the option id, text, ordinal, and the options of which it, in turn, is the parent.

The option element type is useful if a project would like to establish a predefined list of values and enable the user to indicate those being true for an entry.

The data provided for an element of this type will be an indexed array of element option(s), the properties of which include:

Field Type Description
id string The UUID of the element option.
text string The element option text, provided in the endpoint transaction or fallback locale (if plural, this will be delivered in an object keyed by each).

Text

The preferences for a text element include:

Field Type Description
editor_tools object The editor tool(s) to provide in a user interface, in which each value is a boolean indicating whether or not to display a particular tool, each being identified by a unique key including: blockquote, bold, code, dual-pane, edit-redo, edit-undo, expand, header, horizontal-line, image, italic, line-through, link, list-ordered, list-unordered, preview, table.
iana_type string This indicates a preference in terms of the IANA media type to be identified with this element. Input data is not validated based on this, but the preference would inform an expression if it ought to parse the value differently based on it.
length array of integers The desired length of the textual value for this element (low - high), in which 0 = ∞ (if a zero value, no threshold or limit is enforced for it).
text_editor integer This indicates a preference in terms of the kind of text editor UI to provide for data entry purposes. The exact interpretation of what each of these ought to provide for is up to the project or expression; but this enables the user preparing the element to indicate a preference to base that on, if desired.

The data provided for an element of this type will be a literal text value in the endpoint transaction or fallback locale (if plural, this will be delivered in an object keyed by each).

Register for an Invitation
Thank you!
We'll be in touch.
First Name*
Last Name*
(optional) Business Name
Role*
Email*