platform/entitylists/Entities

Entities are JSON entries within the MZDB (Kibo eCommerce Mongo DB) 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 Kibo eCommerce API and Kibo eCommerce Hypr tags.

Operations

Operation Name Request URI Description
DeleteEntity DELETE %7bentityListFullName%7d%2fentities%2f%7bid%7d

Deletes an entity depending on the context of tenant, master catalog, catalog, or site level. Entities are associated to an entity list (schema and formatting) for displaying within a namespace and context level.

GetEntities GET %7bentityListFullName%7d%2fentities%3fpageSize%3d%7bpageSize%7d%26startIndex%3d%7bstartIndex%7d%26filter%3d%7bfilter%7d%26sortBy%3d%7bsortBy%7d%26responseFields%3d%7bresponseFields%7d

Retrieves a collection of entities with an associated entity list and context level at tenant, master catalog, catalog, or site.

GetEntity GET %7bentityListFullName%7d%2fentities%2f%7bid%7d%3fresponseFields%3d%7bresponseFields%7d

Retrieves an entity with an associated entity list and context level at tenant, master catalog, catalog, or site.

InsertEntity POST %7bentityListFullName%7d%2fentities%2f%3fresponseFields%3d%7bresponseFields%7d

Inserts a new entity per the entered item, the entity list full name, and associated response fields.

UpdateEntity PUT %7bentityListFullName%7d%2fentities%2f%7bid%7d%3fresponseFields%3d%7bresponseFields%7d

Updates the content and associations for an existing entity.