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.

Block List

The Block List action blocks the associated values from appearing in the search results. For example, a workplace may block documents that the user does not have permission to view.

General information

  • Endpoint: https://EXAMPLE_COMPANY.b.lucidworks.cloud/api/apps/APP_NAME/query-rewrite/schema/RULE_TYPE
  • Required parameters are:
    • name
    • field_name
    • field_values
    • 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 = properties
id
source
sourceType
createdOn
updatedOn
reviewer
reviewedOn
review
deployed
tags
description
enabled
matching
groups
effective_range
priority
search_terms
filters
response_values
query_profile_id_ss
zone
doc_type
display_type
additionalProperties
I