platform/entitylists/ListViews

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.

JSON Example

ListView Properties

Property Description
defaultSort

type: string

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

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.

listViewField.name

type: string

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

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.

listViewField.type

type: string

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

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.

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.

security

type: string

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

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
CreateEntityListView POST %7bentityListFullName%7d%2fviews%2f%3fresponseFields%3d%7bresponseFields%7d

Creates an entity list view. Each view provides display context levels (site, tenant, catalog, master catalog) and settings for the list of entities.

DeleteEntityListView DELETE %7bentityListFullName%7d%2fviews%2f%7bviewName%7d

Deletes an entity list view. Any associated entities have the association removed.

GetEntityListView GET %7bentityListFullName%7d%2fviews%2f%7bviewName%7d%3fresponseFields%3d%7bresponseFields%7d

Retrieves a specific `EntityListView`. These views provide schema, rules, and formatting for all associated entities.

GetEntityListViews GET %7bentityListFullName%7d%2fviews%3fresponseFields%3d%7bresponseFields%7d

Retrieves a collection of `EntityListViews`. These views provide schema, rules, and formatting for all associated entities.

GetViewEntities GET %7bentityListFullName%7d%2fviews%2f%7bviewName%7d%2fentities%3fpageSize%3d%7bpageSize%7d%26startIndex%3d%7bstartIndex%7d%26filter%3d%7bfilter%7d%26responseFields%3d%7bresponseFields%7d

Retrieves a collection of views for associated entities. Each view provides display context levels (site, tenant, catalog, master catalog) and settings.

GetViewEntity GET %7bentityListFullName%7d%2fviews%2f%7bviewName%7d%2fentities%2f%7bentityId%7d%3fresponseFields%3d%7bresponseFields%7d

Retrieves a view for associated entities. A view provides display context levels (site, tenant, catalog, master catalog) and settings.

GetViewEntityContainer GET %7bentityListFullName%7d%2fviews%2f%7bviewName%7d%2fentityContainers%2f%7bentityId%7d%3fresponseFields%3d%7bresponseFields%7d

Retrieves a collection of container data for creating and displaying a view of entities.

GetViewEntityContainers GET %7bentityListFullName%7d%2fviews%2f%7bviewName%7d%2fentityContainers%3fpageSize%3d%7bpageSize%7d%26startIndex%3d%7bstartIndex%7d%26filter%3d%7bfilter%7d%26responseFields%3d%7bresponseFields%7d

Retrieves a collection of container data for creating and displaying a view of entities.

UpdateEntityListView PUT %7bentityListFullName%7d%2fviews%2f%7bviewName%7d%3fresponseFields%3d%7bresponseFields%7d

Updates an existing entity list view. Each view provides display context levels (site, tenant, catalog, master catalog) and settings for the list of entities.