createFacetList
post
/gsadmin/v1/{appName}/content/facets/{facetListName}
Create a facet list
Request
Supported Media Types
- application/json
Path Parameters
-
appName(required): string
Specifies the name of your application. For example, "cloud".
-
facetListName(required): string
Specifies the name of the new facet list. For example, "default".
The facet list that defines an explicit order of facets at a given location.
Root Schema : FacetList
Type:
object
Represents a facet order list.
Show Source
-
contentItem(required):
object contentItem
-
ecr:createDate:
string
-
ecr:lastModified:
string
-
ecr:lastModifiedBy:
string
-
ecr:type(required):
string
Default Value:
content-item
Allowed Values:[ "content-item" ]
-
priority(required):
integer(int32)
-
triggers(required):
array triggers
-
workflowState:
string
Nested Schema : contentItem
Type:
Show Source
object
-
@type(required):
string
Default Value:
GuidedNavigation
- navigation(required): array navigation
-
showAll:
boolean
Nested Schema : items
Type:
Show Source
object
-
dvalIDs:
array dvalIDs
Specifies a list of locations (facet or facet value IDs) in the storefront where the facet list is to be used.
-
exactLocation:
boolean
-
matchmode:
string
Specifies the match mode to use for the search terms. The value should be one of the following: MATCHPHRASE, MATCHEXACT, MATCHALL.
-
searchTerms:
string
Specifies the search terms based location in the storefront where the facet list is to be used.
Nested Schema : dvalIDs
Type:
array
Specifies a list of locations (facet or facet value IDs) in the storefront where the facet list is to be used.
Show Source
Security
-
basicAuth: basic
Type:
basic
Description:Basic username/password authentication.
Response
Supported Media Types
- application/json
201 Response
Indicates that the new facet list definition was successfully created.
Examples
The following example shows how to create a facet list:
Request Body Example
The following shows how to create a facet list called Facet1
.
{ "ecr:type": "content-item", "workflowState": "ACTIVE", "contentItem": { "@type": "GuidedNavigation", "showAll": false, "navigation": [ { "@type": "RefinementMenu","@name": "Category", "dimensionName": "product.category" }, { "@type": "RefinementMenu","@name": "Price Range", "dimensionName": "product.priceRange" }, { "@type": "RefinementMenu","@name": "Brand", "dimensionName": "product.brandName" } ] } "triggers": [{ "exactLocation": true, "dvalIDs": ["101022"] }] }