platform/entitylists

The Entity Lists resource manages all dynamic entities in your Kibo eCommerce document store of the Kibo eCommerce 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.

Note: 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.

JSON Example

EntityList Properties

Property Description
contextLevel

type: string

At which context level are entities stored in the list. Possible values are "tenant", "site", "masterCatalog" or "catalog". Each list instance will exist at this context level for the tenant.

createDate

type: DateTime

The date and time in UTC format set when the object was created.

idProperty

type: indexedProperty

An IndexedProperty defintion which indicates the property on every entity provided should be used as the unique identifier for the document. Within an EntityList instance each entity must have a unique identifier.

indexedProperty.dataType

type: string

The data type of the source product property, typically of type Bool, DateTime, Number, or String.

indexedProperty.propertyName

type: string

A JPath query indicating the property that should be indexed to enable querying and sorting. Non-indexed properties may be used in queries as long as at least one indexed property is also provided in the query.

indexA

type: indexedProperty

An IndexedProperty defintion which indicates a property on every entity provided that should be indexed to enable querying and sorting. Non-indexed properties may be used in queries as long as at least one indexed property is also provided in the query.

indexedProperty.dataType

type: string

The data type of the source product property, typically of type Bool, DateTime, Number, or String.

indexedProperty.propertyName

type: string

A JPath query indicating the property that should be indexed to enable querying and sorting. Non-indexed properties may be used in queries as long as at least one indexed property is also provided in the query.

indexB

type: indexedProperty

An IndexedProperty defintion which indicates a property on every entity provided that should be indexed to enable querying and sorting. Non-indexed properties may be used in queries as long as at least one indexed property is also provided in the query.

indexedProperty.dataType

type: string

The data type of the source product property, typically of type Bool, DateTime, Number, or String.

indexedProperty.propertyName

type: string

A JPath query indicating the property that should be indexed to enable querying and sorting. Non-indexed properties may be used in queries as long as at least one indexed property is also provided in the query.

indexC

type: indexedProperty

An IndexedProperty defintion which indicates a property on every entity provided that should be indexed to enable querying and sorting. Non-indexed properties may be used in queries as long as at least one indexed property is also provided in the query.

indexedProperty.dataType

type: string

The data type of the source product property, typically of type Bool, DateTime, Number, or String.

indexedProperty.propertyName

type: string

A JPath query indicating the property that should be indexed to enable querying and sorting. Non-indexed properties may be used in queries as long as at least one indexed property is also provided in the query.

indexD

type: indexedProperty

An IndexedProperty defintion which indicates a property on every entity provided that should be indexed to enable querying and sorting. Non-indexed properties may be used in queries as long as at least one indexed property is also provided in the query.

indexedProperty.dataType

type: string

The data type of the source product property, typically of type Bool, DateTime, Number, or String.

indexedProperty.propertyName

type: string

A JPath query indicating the property that should be indexed to enable querying and sorting. Non-indexed properties may be used in queries as long as at least one indexed property is also provided in the query.

isLocaleSpecific

type: bool

Indicates whether MZDB should store entities in the EntityList instance specific to the localeCode provided. If true, all operations on the EntityList will be filtered by the provided localeCode on the request or using the defautLocaleCode for the context. All entities created in the EntityList will be stored with the localeCode provided on the request or the defautLocaleCode for the context as an additional implicit key. The default value is false.

isSandboxDataCloningSupported

type: bool

Indicates whether MZDB should clone all of the Entities in the EntityList when cloning an existing sandbox for which this list is already defined. The default value is false.

isShopperSpecific

type: bool

Indicates whether MZDB should store entities in the EntityList instance specific to the current shopper on the request. If true, all operations on the EntityList will be filtered by the id of the shopper from the shopper claims provided on the request. All entities created in the EntityList will be stored with the id of the shopper from the shopper claims provided on the request as an additional implicit key. The default value is false.

isVisibleInStorefront

type: bool

Indicates whether Enitities in the EntityList are allowed to be accessed from a Kibo eCommerce storefront.

metadata

type: Mozu.Core.Api.Contracts.Json

Metadata content for entities, used by document lists, document type lists, document type, views, entity lists, and list views.

name

type: string

The user supplied name that appears in Admin. You can use this field for identification purposes.

nameSpace

type: string

The namespace for the accessible APIs and source capabilities in the core of Kibo eCommerce APIs.

tenantId

type: int

Unique identifier for the tenant.

updateDate

type: DateTime

The date and time in UTC format the object was updated most recently.

usages

type: list of string

A string array that determines where the document or entity list displays. The options are entityManager, for displaying content in the Custom Schema page in Admin, and siteBuilder, for displaying content in the site tree in Site Builder (applies only to document lists). The following example demonstrates how to display content across both options:

"usages": ["siteBuilder", "entityManager"]

useSystemAssignedId

type: bool

Indicates whether or not Kibo eCommerce should assign a generated identifier for each entity in the list or whether a unique identifier will be provided for each identity. If set to false, then a value must be provided for the IdProperty for the list.

views

type: list of listView

The view in the site used by associated entities or document lists/list types.

listView.defaultSort

type: string

Sets the default sorting for content. Sort does not use AND in determining the order.

listView.fields

type: list of listViewField

The list of fields to display for a view or an associated schema. For example, the address schema would display fields for postal addresses.

listView.listViewField.name

type: string

The user supplied name that appears in Admin. You can use this field for identification purposes.

listView.listViewField.target

type: string

Targets represent the object, such as an item to apply discounts to(products or orders) or a view field for content. Targets are the dot notations that link to the source document property. For example, firstitem for the direct level or firstitem.seconditem.thirditem for a deeper property.

listView.listViewField.type

type: string

The type of scope, which is a developer account or production tenant.

listView.filter

type: string

Used to filter and refine queries, returning data that matches the filter query. If multiple filters are used, they are ANDed together in the query. Filters use expressions to locate content based on a field and operator, such as `cn `for contains.

listView.metaData

type: Mozu.Core.Api.Contracts.Json

Metadata content for entities, used by document lists, document type lists, document type, views, entity lists, and list views.

listView.name

type: string

The user supplied name that appears in Admin. You can use this field for identification purposes.

listView.security

type: string

Indicates the security level for the document content as public, administrator, or owner.

listView.usages

type: list of string

A string array that determines where the document or entity list displays. The options are entityManager, for displaying content in the Custom Schema page in Admin, and siteBuilder, for displaying content in the site tree in Site Builder (applies only to document lists). The following example demonstrates how to display content across both options:

"usages": ["siteBuilder", "entityManager"]

Operations

Operation Name Request URI Description
CreateEntityList POST %3fresponseFields%3d%7bresponseFields%7d

Create a new EntityList for a specific tenant.

DeleteEntityList DELETE %7bentityListFullName%7d

Delete an existing EntityList for a specific tenant. This will also delete all Entities in all instances of this EntityList for the tenant.

GetEntityList GET %7bentityListFullName%7d%3fresponseFields%3d%7bresponseFields%7d

Get an existing EntityList definition for a specific tenant

GetEntityLists GET %3fpageSize%3d%7bpageSize%7d%26startIndex%3d%7bstartIndex%7d%26filter%3d%7bfilter%7d%26sortBy%3d%7bsortBy%7d%26responseFields%3d%7bresponseFields%7d

Get a filtered list of EntityLists for a specific tenant.

UpdateEntityList PUT %7bentityListFullName%7d%3fresponseFields%3d%7bresponseFields%7d

Update an existing Entitylist for a specific tenant.