Jump to

• Request
• Response
• Examples

createFacetList

post

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

Create a facet list

Request

Supported Media Types

• application/json

Path Parameters

• appName: string
  Specifies the name of your application. For example, "cloud".
• facetListName: string
  Specifies the name of the new facet list. For example, "default".

Body ()

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: object contentItem
• ecr:createDate(optional): string
• ecr:lastModified(optional): string
• ecr:lastModifiedBy(optional): string
• ecr:type: string
  Default Value: content-item

  Allowed Values: [ "content-item" ]
• priority: integer(int32)
• triggers: array triggers
• workflowState(optional): string

{
    "type":"object",
    "required":[
        "contentItem",
        "ecr:type",
        "priority",
        "triggers"
    ],
    "properties":{
        "ecr:type":{
            "type":"string",
            "default":"content-item",
            "enum":[
                "content-item"
            ]
        },
        "contentItem":{
            "type":"object",
            "properties":{
                "navigation":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "@type":{
                                "type":"string",
                                "default":"RefinementMenu",
                                "enum":[
                                    "RefinementMenu"
                                ]
                            },
                            "dimensionName":{
                                "type":"string"
                            }
                        },
                        "required":[
                            "@type",
                            "dimensionName"
                        ]
                    }
                },
                "showAll":{
                    "type":"boolean"
                },
                "@type":{
                    "type":"string",
                    "default":"GuidedNavigation"
                }
            },
            "required":[
                "@type",
                "navigation"
            ]
        },
        "priority":{
            "type":"integer",
            "format":"int32"
        },
        "triggers":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "exactLocation":{
                        "type":"boolean"
                    },
                    "searchTerms":{
                        "type":"string",
                        "description":"Specifies the search terms based location in the storefront where the facet list is to be used."
                    },
                    "matchmode":{
                        "type":"string",
                        "description":"Specifies the match mode to use for the search terms. The value should be one of the following: MATCHPHRASE, MATCHEXACT, MATCHALL."
                    },
                    "dvalIDs":{
                        "type":"array",
                        "description":"Specifies a list of locations (facet or facet value IDs) in the storefront where the facet list is to be used.",
                        "items":{
                            "type":"string"
                        }
                    }
                }
            }
        },
        "ecr:createDate":{
            "type":"string"
        },
        "ecr:lastModified":{
            "type":"string"
        },
        "ecr:lastModifiedBy":{
            "type":"string"
        },
        "workflowState":{
            "type":"string"
        }
    },
    "description":"Represents a facet order list."
}

Nested Schema : contentItem

Type: object

Show Source

• @type: string
  Default Value: GuidedNavigation
• navigation: array navigation
• showAll(optional): boolean

{
    "type":"object",
    "properties":{
        "navigation":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "@type":{
                        "type":"string",
                        "default":"RefinementMenu",
                        "enum":[
                            "RefinementMenu"
                        ]
                    },
                    "dimensionName":{
                        "type":"string"
                    }
                },
                "required":[
                    "@type",
                    "dimensionName"
                ]
            }
        },
        "showAll":{
            "type":"boolean"
        },
        "@type":{
            "type":"string",
            "default":"GuidedNavigation"
        }
    },
    "required":[
        "@type",
        "navigation"
    ]
}

Nested Schema : triggers

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "exactLocation":{
                "type":"boolean"
            },
            "searchTerms":{
                "type":"string",
                "description":"Specifies the search terms based location in the storefront where the facet list is to be used."
            },
            "matchmode":{
                "type":"string",
                "description":"Specifies the match mode to use for the search terms. The value should be one of the following: MATCHPHRASE, MATCHEXACT, MATCHALL."
            },
            "dvalIDs":{
                "type":"array",
                "description":"Specifies a list of locations (facet or facet value IDs) in the storefront where the facet list is to be used.",
                "items":{
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : navigation

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "@type":{
                "type":"string",
                "default":"RefinementMenu",
                "enum":[
                    "RefinementMenu"
                ]
            },
            "dimensionName":{
                "type":"string"
            }
        },
        "required":[
            "@type",
            "dimensionName"
        ]
    }
}

Nested Schema : items

Type: object

Show Source

• @type: string
  Default Value: RefinementMenu

  Allowed Values: [ "RefinementMenu" ]
• dimensionName: string

{
    "type":"object",
    "properties":{
        "@type":{
            "type":"string",
            "default":"RefinementMenu",
            "enum":[
                "RefinementMenu"
            ]
        },
        "dimensionName":{
            "type":"string"
        }
    },
    "required":[
        "@type",
        "dimensionName"
    ]
}

Nested Schema : items

Type: object

Show Source

• dvalIDs(optional): array dvalIDs
  Specifies a list of locations (facet or facet value IDs) in the storefront where the facet list is to be used.
• exactLocation(optional): boolean
• matchmode(optional): string
  Specifies the match mode to use for the search terms. The value should be one of the following: MATCHPHRASE, MATCHEXACT, MATCHALL.
• searchTerms(optional): string
  Specifies the search terms based location in the storefront where the facet list is to be used.

{
    "type":"object",
    "properties":{
        "exactLocation":{
            "type":"boolean"
        },
        "searchTerms":{
            "type":"string",
            "description":"Specifies the search terms based location in the storefront where the facet list is to be used."
        },
        "matchmode":{
            "type":"string",
            "description":"Specifies the match mode to use for the search terms. The value should be one of the following: MATCHPHRASE, MATCHEXACT, MATCHALL."
        },
        "dvalIDs":{
            "type":"array",
            "description":"Specifies a list of locations (facet or facet value IDs) in the storefront where the facet list is to be used.",
            "items":{
                "type":"string"
            }
        }
    }
}

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

• Array of: string

{
    "type":"array",
    "description":"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: basic
  Type: basic

  Description: Basic username/password authentication.

Back to Top

Response

Supported Media Types

• application/json

201 Response

Indicates that the new facet list definition was successfully created.

Body ()

Root Schema : Response

Type: object

Show Source

• message(optional): string
• status(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "message":{
            "type":"string"
        },
        "status":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Back to Top

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

Back to Top