close anchor

Elements

To get information on elements:

GET /elements

Parameters

Param Type Description Optional
id string The UUID of an individual element.
type string Indicate, by providing a comma-delimited list, the type(s) by which to filter elements, being of those provided by the /element/types endpoint.
group string Indicate, by providing a comma-delimited list, the UUID of element or user group(s) by which to filter elements. Include a '+' prefix before this list of groups for elements to be identified with every group declared (the default behavior of this endpoint is to provide elements in any of the group(s) included), and prefix an individual group therein with '!' to exclude those linked to it.
enabled boolean Indicate whether or not to filter elements based on this property. Include a value of either true or false to indicate the elements to be provided.
optional boolean Indicate whether or not to filter elements based on this property. Include a value of either true or false to indicate the elements to be provided.
text string Include text by which to filter entries. Input will be parsed for up to ten keywords and treated as a filter, in that only entries with keyword(s) present in the fields below will be included.
fields string Indicate, by providing a comma-delimited list, the field(s) in which to expect text keyword(s) be present. If a field includes localized text, only values in the endpoint transaction locale will be queried. If empty or not provided, each of these valid fields will be included: description, name.
order string Indicate, by providing a comma-delimited list, the field(s) by which to order entries found. Include a '-' prefix if descending order is preferred in a given field ('+' is inferred by default). If empty or not provided, these valid fields will not be explicitly included: date_time.edit, date_time.init, id, name.

If plural locales indicated for the endpoint transaction and name is present in the list of field(s) to order by, querying will be performed in the initial locale (but data will be included for each).
page integer Identify the page on which to begin delivering entries. If not provided, the default value of 1 will be inferred.
limit integer Indicate a total of up to 100 entries to be delivered. If not provided, the default value of 10 will be inferred.
data string Indicate, by providing a comma-delimited list, the data field(s) to be delivered by this endpoint. If empty or not provided, this endpoint will include by default each of the data field(s) identified with the element object.

The data object provided by this endpoint includes both a total (integer) of entries found, and an index (array) of element object(s).

To post an element:

POST /elements

In order to post an element, log in a user identified with owner-level privileges.

Parameters

Provide the input field(s) below as a JSON-encoded data object:

Param Type Description Optional
name string The name of the element, provided in the endpoint transaction locale.
description string The textual description for this element, provided in the endpoint transaction locale.
type string The element type, being one of the types provided by the /element/types endpoint.
enabled boolean Indicate whether or not the element is to be enabled.
optional boolean Indicate whether a non-empty value is to be expected for this element, independent of its type.
preferences object The preferences for this element, based on its element type.

The data object provided by this endpoint is the element object inserted to the project.

Errors

If there is an endpoint transaction failure, or a problem with user input data, an error is provided:

ID/Type Description
iana_type_not_found The IANA media type is not of those presently identified with textual element data, a list of which is provided by the /file/types endpoint.
integer_not_provided The data value provided is not an integer.
invalid_editor_tool The editor tool key provided is not valid.
invalid_element_data_type The element data type preference is not valid.
invalid_element_name The element name is an empty value or not provided.
invalid_element_type The element type is not valid.
invalid_file_type_group The file type group is not valid or known to the Elebase platform.
invalid_geo_data_point The point is not a valid geographic location.
invalid_text_editor_pref The text editor preference is not valid.
type_not_found The type(s) provided include a content type which does not exist in the project. The data included for this error will be the ID of the type not found.

If an error is not described on this page, the platform-wide error table provides further information.

To edit or update an element:

PUT /elements

In order to update an element, log in a user identified with owner-level privileges.

Parameters

Provide the input field(s) below as a JSON-encoded data object:

Param Type Description Optional
id string The UUID of the element for which data is being updated.
name string The name of the element, provided in the endpoint transaction locale.
description string The textual description for this element, provided in the endpoint transaction locale.
enabled boolean Indicate whether or not the element is to be enabled.
optional boolean Indicate whether a non-empty value is to be expected for this element.
preferences object The preferences for this element, based on its element type.
options array The option(s) identified with an option-type element, being an indexed array in which each value is an object including the option id, text (provided in the endpoint transaction lcoale), and the options of which it, in turn, is the parent (if any), in order by the desired position of each (do not include the option in question, or a parent thereof, in the options index for an option or this endpoint will either delete that option or yield an error as indicated below).

Individual element option(s) not included in this transaction will be deleted. The parent, order and textual label of the option(s) included in the transaction will be updated. In order to update element option(s) individually, or as a partial batch (not deleting option(s) excluded from the transaction), use the /element/options endpoint instead.
groups object The element and/or user group(s) in which this element is to exist, or to which it will be linked, each being a one-dimensional array in which each value is the UUID of an individual element or user group.

The element will no longer be identified with groups not included in this transaction. In order to post an element to a group individually (not deleting it from other groups in which it'd previously been included), use the /element/groups endpoint instead.
attributes object The entity-attribute-value data to be identified with this entity.

The data object provided by this endpoint is the updated element object.

Errors

If there is an endpoint transaction failure, or a problem with user input data, an error is provided:

ID/Type Description
entity_in_use If updating an option-type element, the option indicated is presently in use, being identified with content entries in the project. The data included for this error will be the ID of the element option not to be excluded or deleted.
iana_type_not_found The IANA media type is not of those presently identified with textual element data, a list of which is provided by the /file/types endpoint.
illegal_parent_option The parent option indicated either does not exist, is not identified with the element, or is a descendant of the option in question. In order to prevent an infinite loop, do not indicate a parent option for which this option would be a parent, too.
integer_not_provided The data value provided is not an integer.
invalid_editor_tool The editor tool key provided is not valid.
invalid_element_data_type The element data type preference is not valid.
invalid_element_name The element name is an empty value or not provided.
invalid_element_option The option indicated does not exist or is not identified with the element.
invalid_file_type_group The file type group is not valid or known to the Elebase platform.
invalid_geo_data_point The point is not a valid geographic location.
invalid_text_editor_pref The text editor preference is not valid.
text_not_provided The element option text is an empty value or not provided.
type_not_found The type(s) provided include a content type which does not exist in the project. The data included for this error will be the ID of the type not found.

If an error is not described on this page, the platform-wide error table provides further information.

To delete an element:

DELETE /elements

In order to delete an element, log in a user identified with owner-level privileges.

Parameters

Param Type Description
id string The UUID of the element to be deleted.

The data object provided by this endpoint is the deleted element.

Errors

If there is an endpoint transaction failure, or a problem with user input data, an error is provided:

ID/Type Description
entity_in_use The element was not deleted because it is presently in use, being identified with existing type(s).

If an error is not described on this page, the platform-wide error table provides further information.

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