Entities Overview

Entities are JSON entries within the Kibo database for handling large data sets to heavily filter (>2,000 items). Each entity is associated to an EntityList with schema, rules, and formatting for storing the content. This content can be accessed via the API and Hypr tags.

Some tips for using different resources of the Entities APIs:

  • The Entity Lists resource manages all dynamic entities in your Kibo eCommerce document store of the cloud. The content is JSON and can have up to five indexed properties (integer, decimal, string, date, and boolean) with support for additional customized elements as needed. Every document in the entity list has a validated unique ID. A Content property is not supported for Entity List. Instead, the MetaData JSON property should be used to supply content when needed. Otherwise, to populate an Entity List the user should create an entity and then add that resource to the list using the InsertEntity operation.
  • The Entity Containers resource provides all properties and data for entities within a site/tenant. This data encapsulates all associated IDs including entity lists, entity views, site, tenant, entities, and more.
  • The List Views resource provides settings and options for displaying associated content within a context level of site, tenant, catalog, or master catalog. ListViews can be associated with entity lists and entities.