createFacetList

post

/gsadmin/v1/{appName}/content/facets/{facetListName}

Create a facet list

• Request
• Response
• Examples

Request

Supported Media Types

• application/json

Path Parameters

appName

Type: string

Required: true

Specifies the name of your application. For example, "cloud".

facetListName

Type: string

Required: true

Specifies the name of the new facet list. For example, "default".

Body Parameter

The facet list that defines an explicit order of facets at a given location.

Root Schema : FacetList

Type: object

Represents a facet order list.

Properties

contentItem

Type: object contentItem

Required: true

Additional Properties Allowed:

ecr:createDate

Type: string

ecr:lastModified

Type: string

ecr:lastModifiedBy

Type: string

ecr:type

Type: string

Required: true

Default Value: content-item

Allowed Values: [ "content-item" ]

priority

Type: integer (int32)

Required: true

triggers

Type: array triggers

Required: true

Additional Properties Allowed:

workflowState

Type: string

Nested Schema : contentItem

Type: object

Properties

@type

Type: string

Required: true

Default Value: GuidedNavigation

navigation

Type: array navigation

Required: true

Additional Properties Allowed:

showAll

Type: boolean

Nested Schema : triggers

Type: array

Items

• Type: object items
  Additional Properties Allowed:

Nested Schema : navigation

Type: array

Items

• Type: object items
  Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

@type

Type: string

Required: true

Default Value: RefinementMenu

Allowed Values: [ "RefinementMenu" ]

dimensionName

Type: string

Required: true

Nested Schema : items

Type: object

Properties

dvalIDs

Type: array dvalIDs

Additional Properties Allowed:

Specifies a list of locations (facet or facet value IDs) in the storefront where the facet list is to be used.

exactLocation

Type: boolean

matchmode

Type: string

Specifies the match mode to use for the search terms. The value should be one of the following: MATCHPHRASE, MATCHEXACT, MATCHALL.

searchTerms

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

Items

• Type: string

Security

basicAuth

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.

Body

Root Schema : Response

Type: object

Properties

message

Type: string

status

Type: integer (int32)

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"]
    }]
}