Skip to content

Files

Latest commit

leekelleherleekelleher
Data Sources: Added docs for Umbraco Entities
Jun 15, 2022
e3237a3 · Jun 15, 2022

History

History
40 lines (26 loc) · 1.63 KB
·

data-source--umbraco-entity.md

File metadata and controls

40 lines (26 loc) · 1.63 KB
·

Contentment for Umbraco logo

Contentment for Umbraco

Data Sources

Umbraco Entities

This data-source lets you to select an Umbraco entity type to populate the items of a compatible editor, e.g. Data List.

A note about supported Umbraco entity types.

Umbraco's EntityService API (currently) has limited support for querying entity types by GUID or UDI.

At the time of writing, the available supported entity types are:

  • Data Type
  • Document
  • Document Blueprint
  • Document Type
  • Media
  • Media Type
  • Member
  • Member Type
How to configure the editor?

The configuration of the Umbraco entities data-source has the following options:

Configuration Editor for Umbraco entities

The Entity type field will let you select the Umbraco entity type to use.

What is the value's object-type?

The value for the Umbraco entities data-source item will be an instance of IEntitySlim, representing a slim version of the entity object. Depending on the List editor used, this may be wrapped in a List<IEntitySlim>.

To retrieve the full instance of the entity, you would need to make a call to the corresponding Service API. Please keep in mind that these may query the database directly.