close anchor

Embeds

To get information on embed objects:

GET /embeds

Parameters

Param Type Description Optional
id string The UUID of an individual embed.
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, ip_attribution, title, url.
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, title, url.

If plural locales indicated for the endpoint transaction and title 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 embed object.

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

To post an embed object:

POST /embeds

In order to post an embed, log a user in.

Parameters

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

Param Type Description Optional
url string The URL of the embed object.
title string The title of this embed, provided in the endpoint transaction locale.
description string The embed description text, provided in the endpoint transaction locale.
editable boolean Indicate whether or not this embed is to be editable by users with editor-level privileges.
ip_attribution string The producer (or intellectual property owner) of the embed, provided in the endpoint transaction locale.
locale string The locale identified with this embed object, for example the language in which a video is presented.

The data object provided by this endpoint is the embed 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
embed_not_found The embed does not exist or the oembed provider is down.
invalid_locale The locale is not valid or known on the Elebase platform.
invalid_url The url provided is empty, badly formed or the embed provider does not exist or is not public.

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

To edit or update an embed object:

PUT /embeds

In order to update an embed, log in the primary user identified with it (or a user with owner-level privileges) or, if its 'editable' preference is true, an editor-level user.

Parameters

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

Param Type Description Optional
id string The UUID of the embed object for which data is being updated.
title string The title of this embed, provided in the endpoint transaction locale.
description string The embed description text, provided in the endpoint transaction locale.
editable boolean Indicate whether or not this embed is to be editable by users with editor-level privileges.
ip_attribution string The producer (or intellectual property owner) of the embed, provided in the endpoint transaction locale.
locale string The locale identified with this embed object, for example the language in which a video is presented.

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

Errors

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

ID/Type Description
invalid_locale The locale is not valid or known on the Elebase platform.

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

To delete an embed object:

DELETE /embeds

In order to delete an embed, log in the user identified with the embed (or a user with owner-level privileges).

Parameters

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

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

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