Add ListView

Create a new ListView definition for a specific EntityList for a specific tenant

POST /platform/entitylists/{entityListFullName}/views

Error

A valid request URL is required to generate request examples

200

{
  "defaultSort": "<string>",
  "fields": [
    {
      "name": "<string>",
      "target": "<string>",
      "type": "<string>"
    }
  ],
  "filter": "<string>",
  "metaData": {},
  "name": "<string>",
  "security": "<string>",
  "usages": [
    "<string>"
  ]
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Path Parameters

entityListFullName · string · required

The full name of the EntityList including namespace in name@nameSpace format

Query Parameters

responseFields · string

limits which fields are returned in the response body

Body

application/json

The new ListView definition

defaultSort · string | null

Indicates a default sort to be applied to the ListView.

fields · object[] | null

The list of ViewFields for this view. ViewFields can be used to filter or transform the underlying Entity to provide an optimized format for applications which query the ListView. If no ViewFields are specified, entities will be returned for the View with no transform applied.

Show child attributes

filter · string | null

Indicates a implicitly applied filter to the EntityList for to which the ListView is associated. All queries to the ListView will have this filter applied implicitly.

metaData · object

An arbitrary json property to be used by external applications for any purpose. MZDB will persist and retrieve the metadata without any restrictions.

name · string | null

The name of the ListView. This must be unique for the EntityList.

security · string | null

less restrictive than collection/list security. public | admin | owner

usages · string[] | null

Usages are arbitratry sting values used to provide instructions for other applications as to the intended areas where the view should be used. Mozu uses the "admin" usage valued to indicate that a ListView should appear in the EntityManager in the Admin UI. The values are open ended and applications may provide any value for a usage. This field can be used in queries to the EntityList.

Response

200

application/json

OK

defaultSort · string | null

Indicates a default sort to be applied to the ListView.

fields · object[] | null

The list of ViewFields for this view. ViewFields can be used to filter or transform the underlying Entity to provide an optimized format for applications which query the ListView. If no ViewFields are specified, entities will be returned for the View with no transform applied.

Show child attributes

filter · string | null

Indicates a implicitly applied filter to the EntityList for to which the ListView is associated. All queries to the ListView will have this filter applied implicitly.

metaData · object

An arbitrary json property to be used by external applications for any purpose. MZDB will persist and retrieve the metadata without any restrictions.

name · string | null

The name of the ListView. This must be unique for the EntityList.

security · string | null

less restrictive than collection/list security. public | admin | owner

usages · string[] | null

Usages are arbitratry sting values used to provide instructions for other applications as to the intended areas where the view should be used. Mozu uses the "admin" usage valued to indicate that a ListView should appear in the EntityManager in the Admin UI. The values are open ended and applications may provide any value for a usage. This field can be used in queries to the EntityList.