Insert facet value records into record collection
post
/gsdata/v1/{appName}/facets/{recordCollection}
Insert records into the specified record collection. If record with the same key and locale already exist in the collection it will be overwritten. Changing records (whether adding, deleting or updating) requires a baseline index for the changes to take effect. Users must not manipulate system created record collections, eg records in /cloud/facets/product.category or product.priceRange, as these changes would be overwritten on the next catalog indexing event.
Request
Supported Media Types
- application/json
Path Parameters
-
appName: string
Specifies the name of your application. For example, "cloud".
-
recordCollection: string
Name of the record collection. A valid record collection name is defined by the regular expression "^[a-zA-Z0-9._-]+$" and cannot exceed 128 characters.
Represents a facet order list.
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
Nested Schema : contentItem
Type:
Show Source
object
-
@type:
string
Default Value:
GuidedNavigation
- navigation: array navigation
-
showAll(optional):
boolean
Nested Schema : items
Type:
Show Source
object
-
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.
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
POST request was successful.
Root Schema : PostRecordsResponse
Type:
object
Represents the response received from a POST request to insert records into record collection.
Show Source
-
importRecordsStatus(optional):
object ImportRecordsStatus
Represents a status of records being imported by this POST request.
-
importRecordsSummary(optional):
object ImportRecordsSummary
Represents a summary of records imported by this POST request.
-
links(optional):
array links
-
status(optional):
integer
-
title(optional):
string
Nested Schema : ImportRecordsStatus
Type:
object
Represents a status of records being imported by this POST request.
Show Source
Nested Schema : ImportRecordsSummary
Type:
object
Represents a summary of records imported by this POST request.
Show Source
Nested Schema : links
Type:
Show Source
array
-
Array of:
object Link
Represents a link to a gsdata resource.