Skip to main content
This rule type is used in the Query Rewrite API. For a complete list of rule and rewrite types in the Query Rewrite API, see Query Rewrite API Configurations. For more information, view the API specification.

Response Value

The Response Value action sends an arbitrary value to the frontend or pipeline, which the frontend of pipeline can use to perform another action. The Response Value action can be combined with other actions within the same rule. For example, an e-commerce website may use the response value action to display an advertisement.

General information

  • Endpoint: https://EXAMPLE_COMPANY.b.lucidworks.cloud/api/apps/APP_NAME/query-rewrite/schema/RULE_TYPE
  • Required parameters are:
    • name
    • type
  • The values for the hints parameter include:
    • hidden: Do not display in the Fusion UI, but can be read and written in the schema.
    • readonly: Cannot be set by the user. If attempted, an error is generated and the operation fails.

Parameters and schemas

type = string
id
source
sourceType
createdOn
updatedOn
reviewer
reviewedOn
review
deployed
tags
name
required
description
enabled
matching
groups
effective_range
priority
search_terms
filters
response_values
query_profile_id_ss
type
required
doc_type
display_type
additionalProperties
I