1. REST API for Oracle Commerce Cloud 21C
  2. Tasks
  3. Admin
  4. Search Data and Indexing
  5. Insert Records

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
Path Parameters
  • Specifies the name of your application. For example, "cloud".
  • 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.
Body ()
Represents a list of facet value records.
Root Schema : FacetList
Type: object
Represents a list of facet value records.
Show Source
Example:
{
    "items":[
        {
            "key":"Acme",
            "displayOrder":"1",
            "x_imageUrl":"acme.png",
            "x_description":"Acme is a great brand"
        },
        {
            "key":"Value Brand",
            "displayOrder":"2",
            "x_imageUrl":"valueBrand.png",
            "x_description":"Value Brand is a great brand"
        }
    ]
}
Nested Schema : items
Type: array
Show Source
  • FacetValue
    Represents a facet value record from a facet record collection. This can be used to specify displayOrder and custom properties for a facet value. Custom properties must contain an underscore character. For example 'x_imageUrl' might be created to associate an image with a facet value.
Nested Schema : FacetValue
Type: object
Represents a facet value record from a facet record collection. This can be used to specify displayOrder and custom properties for a facet value. Custom properties must contain an underscore character. For example 'x_imageUrl' might be created to associate an image with a facet value.
Show Source
  • Optionally specifies a display name. If no 'displayName' is configured, the 'key' is used. This is useful if you want to match data records on one value, but display another.
    Example: Acme Brand
  • Specifies the order display when the given facets is sorted by 'displayOrder' within 'displayConfig' under /attributes
    Example: 1
  • This is used when matching data records during indexing.
    Example: Acme
  • If this attribute has a context=locale under /attributes, then a locale code must be specified to match data records. To view the list of configured locale codes, you can GET /gsadmin/v1/cloud/searchIndexConfig and examine the union of 'defaultLocale' plus 'locales'.
    Example: en
  • Specifies the lower bound for a range facet value. The facet configuration /gsadmin/v1/cloud/attributes/system/{attribute name} need to specify a 'rangeComparisonType' to configure a facet as a range facet. The values that you POST to /gsdata are wrapped in quotes, but the actual value inside must match the 'rangeComparisonType'. The configured lower bound is inclusive.
    Example: 4.500
  • If this attribute has a context=priceGroup under /attributes, then a priceGroup name must be specified to match data records. To view the list of currently configured priceGroup values, you can GET /gsadmin/v1/cloud/attributeContexts/priceGroup
    Example: defaultPriceGroup
  • Allowed Values: [ "UPSERT", "DELETE" ]
    Instructs the system what to do with this record. If not specified defaults to upsert. Typically, you would only ever specify DELETE to delete an existing facet value record.
    Example:
  • Specifies the upper bound for a range facet value. The facet configuration /gsadmin/v1/cloud/attributes/system/{attribute name} need to specify a 'rangeComparisonType' to configure a facet as a range facet. The values that you POST to /gsdata are wrapped in quotes, but the actual value inside must match the 'rangeComparisonType'. The configured upper bound is not inclusive.
    Example: 5.00
Security
Back to Top

Response

Supported Media Types

201 Response

POST request was successful.
Body ()
Root Schema : PostRecordsResponse
Type: object
Represents the response received from a POST request to insert records into record collection.
Show Source
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
Back to Top