A valid request URL is required to generate request examples{
"tenantId": 123,
"nameSpace": "<string>",
"name": "<string>",
"contextLevel": "<string>",
"useSystemAssignedId": true,
"idProperty": {
"propertyName": "<string>",
"dataType": "<string>"
},
"indexA": {
"propertyName": "<string>",
"dataType": "<string>"
},
"indexB": {
"propertyName": "<string>",
"dataType": "<string>"
},
"indexC": {
"propertyName": "<string>",
"dataType": "<string>"
},
"indexD": {
"propertyName": "<string>",
"dataType": "<string>"
},
"isVisibleInStorefront": true,
"isLocaleSpecific": true,
"isShopperSpecific": true,
"isSandboxDataCloningSupported": true,
"views": [
{
"name": "<string>",
"usages": [
"<string>"
],
"metaData": {},
"security": "<string>",
"filter": "<string>",
"defaultSort": "<string>",
"fields": [
{
"name": "<string>",
"type": "<string>",
"target": "<string>"
}
]
}
],
"usages": [
"<string>"
],
"metadata": {},
"createDate": "2023-11-07T05:31:56Z",
"updateDate": "2023-11-07T05:31:56Z"
}Update Entitylist
Update an existing Entitylist for a specific tenant.
A valid request URL is required to generate request examples{
"tenantId": 123,
"nameSpace": "<string>",
"name": "<string>",
"contextLevel": "<string>",
"useSystemAssignedId": true,
"idProperty": {
"propertyName": "<string>",
"dataType": "<string>"
},
"indexA": {
"propertyName": "<string>",
"dataType": "<string>"
},
"indexB": {
"propertyName": "<string>",
"dataType": "<string>"
},
"indexC": {
"propertyName": "<string>",
"dataType": "<string>"
},
"indexD": {
"propertyName": "<string>",
"dataType": "<string>"
},
"isVisibleInStorefront": true,
"isLocaleSpecific": true,
"isShopperSpecific": true,
"isSandboxDataCloningSupported": true,
"views": [
{
"name": "<string>",
"usages": [
"<string>"
],
"metaData": {},
"security": "<string>",
"filter": "<string>",
"defaultSort": "<string>",
"fields": [
{
"name": "<string>",
"type": "<string>",
"target": "<string>"
}
]
}
],
"usages": [
"<string>"
],
"metadata": {},
"createDate": "2023-11-07T05:31:56Z",
"updateDate": "2023-11-07T05:31:56Z"
}Authorizations
JWT Authorization header using the Bearer scheme.
Path Parameters
The full name of the EntityList including namespace in name@nameSpace format
Query Parameters
limits which fields are returned in the response body
Body
The EntityList definition
The definition of an MZDB EntityList which describes the characteristics of the EntityList on a per tenant basis. EntityLists are created at the tenant level, but instances of the EntityLists are implicitly created at the appropriate context level as entities are added or removed from the EntityList.
The nameSpace for the EntityList which must be within the nameSpace scope of the developer Account for the creating application. The name and namespace are formatted as name@nameSpace when specified as fullName. An EntityLists fullName must be unique within the tenant in which it is created.
The name for the EntityList which must be unique within the namespace provided. The name and namespace are formatted as name@nameSpace when specified as fullName. An EntityLists fullName must be unique within the tenant in which it is created.
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.
Indicates whether or not Mozu 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.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Indicates whether Enitities in the EntityList are allowed to be accessed from a Mozu storefront.
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.
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.
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.
The ListViews defined for this EntityList. ListViews may be used to automatically filter an EntityList or transform the Entities in the list to a new Schema.
Show child attributes
Show child attributes
Usages are arbitratry sting values used to provide instructions for other applications as to the intended areas where the list should be used. Mozu uses the "admin" usage valued to indicate that an EntityList 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.
An arbitrary json property to be used by external applications for any purpose. MZDB will persist and retrieve the metadata without any restrictions.
Response
Success
The definition of an MZDB EntityList which describes the characteristics of the EntityList on a per tenant basis. EntityLists are created at the tenant level, but instances of the EntityLists are implicitly created at the appropriate context level as entities are added or removed from the EntityList.
The nameSpace for the EntityList which must be within the nameSpace scope of the developer Account for the creating application. The name and namespace are formatted as name@nameSpace when specified as fullName. An EntityLists fullName must be unique within the tenant in which it is created.
The name for the EntityList which must be unique within the namespace provided. The name and namespace are formatted as name@nameSpace when specified as fullName. An EntityLists fullName must be unique within the tenant in which it is created.
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.
Indicates whether or not Mozu 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.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Indicates whether Enitities in the EntityList are allowed to be accessed from a Mozu storefront.
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.
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.
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.
The ListViews defined for this EntityList. ListViews may be used to automatically filter an EntityList or transform the Entities in the list to a new Schema.
Show child attributes
Show child attributes
Usages are arbitratry sting values used to provide instructions for other applications as to the intended areas where the list should be used. Mozu uses the "admin" usage valued to indicate that an EntityList 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.
An arbitrary json property to be used by external applications for any purpose. MZDB will persist and retrieve the metadata without any restrictions.