Bury List
The Bury List action buries documents with the selected values. This action minimizes certain documents without blocking them. For example, a workplace may bury out-of-date documents.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
hintsparameter 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
Parameters and schemas
type
string = properties
id
Hide child attributes
Hide child attributes
Copy
{
"id": {
"type": "string",
"title": "ID",
"description": "The ID for this Rule. Used in the API to reference this query rewrite rule. Allowed characters: a-z, A-Z, 0-9, dash (-) and underscore (_)",
"maxLength": 128,
"pattern": "^[A-Za-z0-9_\\-]+$"
}
}
source
Hide child attributes
Hide child attributes
Copy
{
"source": {
"type": "string",
"title": "Source",
"description": "The source for this query rewrite rule, such as a Spark Job.",
"hints": ["hidden"]
}
}
sourceType
Hide child attributes
Hide child attributes
Copy
{
"sourceType": {
"type": "string",
"title": "Source Type",
"description": "Source type",
"hints": ["hidden"]
}
}
createdOn
Hide child attributes
Hide child attributes
Copy
{
"createdOn": {
"type": "string",
"title": "Created Date/Time",
"description": "Date/Time this rule was created.",
"format": "date-time"
}
}
updatedOn
Hide child attributes
Hide child attributes
Copy
{
"updatedOn": {
"type": "string",
"title": "Updated Date/Time",
"description": "Date/Time this rule was last updated.",
"format": "date-time"
}
}
reviewer
Hide child attributes
Hide child attributes
Copy
{
"reviewer": {
"type": "string",
"title": "Reviewer",
"description": "Who reviewed this rewrite rule.",
"hints": ["hidden"]
}
}
reviewedOn
Hide child attributes
Hide child attributes
Copy
{
"reviewedOn": {
"type": "string",
"title": "Reviewed Date/Time",
"description": "Date/Time this rule was last reviewed.",
"hints": ["hidden"],
"format": "date-time"
}
}
review
Hide child attributes
Hide child attributes
Copy
{
"review": {
"type": "string",
"title": "Review",
"enum": ["approved", "denied"],
"default": "approved",
"hints": ["readonly"]
}
}
deployed
Hide child attributes
Hide child attributes
Copy
{
"deployed": {
"type": "boolean",
"title": "Deployed Flag",
"description": "Flag to indicate if this rewrite rule has been deployed.",
"hints": ["hidden"]
}
}
tags
Hide child attributes
Hide child attributes
Copy
{
"tags": {
"type": "array",
"title": "Tags",
"description": "Conditional tags to restrict the triggering of this query rewrite rule.",
"items": { "type": "string" }
}
}
description
Hide child attributes
Hide child attributes
Copy
{
"description": {
"type": "string",
"title": "Description",
"description": "Short description of what this rule does."
}
}
enabled
Hide child attributes
Hide child attributes
Copy
{
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "Set to false to disable this rule.",
"default": true
}
}
matching
Hide child attributes
Hide child attributes
Copy
{
"matching": {
"type": "string",
"title": "Match Query Using",
"description": "Defines how the specified search terms will be compared to the user's query to determine whether this rule applies. 'keywords' means the query must match the keywords of the search terms value exactly. 'phrase' means the search query must contain one of the search terms values as a subphrase. 'text' means that at least one of the search terms values must match the query, but unlike 'phrase', the query only needs to match part of the value.",
"enum": ["keywords", "text", "phrase"],
"default": "keywords"
}
}
groups
Hide child attributes
Hide child attributes
Copy
{
"groups": {
"type": "string",
"title": "Rule Group",
"description": "Group for this rule."
}
}
effective_range
Hide child attributes
Hide child attributes
Copy
{
"effective_range": {
"type": "array",
"title": "Effective Range",
"description": "Time range when this rule is in effect.",
"items": { "type": "string" }
}
}
priority
Hide child attributes
Hide child attributes
Copy
{
"priority": {
"type": "integer",
"title": "Precedence",
"description": "Used when multiple rules could take effect for a given query - higher number means higher precedence. For example, a rule with precedence of 10 will take effect before a rule with precedence of 3. Ties on precedence are broken based on creation time - the more recently created rule will take effect before the older rule."
}
}
search_terms
Hide child attributes
Hide child attributes
Copy
{
"search_terms": {
"type": "array",
"title": "Search Terms",
"description": "Search terms that trigger this rule.",
"items": { "type": "string" }
}
}
filters
Hide child attributes
Hide child attributes
Copy
{
"filters": {
"type": "array",
"title": "Filters",
"description": "Filters used to determine if this rule triggers",
"items": {
"type": "object",
"required": ["key","value"],
"properties": {
"key": { "type": "string", "title": "Field Name" },
"value": { "type": "string", "title": "Field Value" }
}
}
}
}
response_values
Hide child attributes
Hide child attributes
Copy
{
"response_values": {
"type": "array",
"title": "Set Response Values",
"description": "Key/Value pairs to set in the fusion section of the response.",
"items": {
"type": "object",
"required": ["key","value"],
"properties": {
"key": { "type": "string", "title": "Field Name" },
"value": { "type": "string", "title": "Field Value" }
}
}
}
}
query_profile_id_ss
Hide child attributes
Hide child attributes
Copy
{
"query_profile_id_ss": {
"type": "array",
"title": "Query Profile ID",
"description": "Query Profile that triggers this rule",
"items": { "type": "string" }
}
}
Hide child attributes
Hide child attributes
Copy
{
"field_name": {
"type": "string",
"title": "Field Name",
"description": "Set the field name used by this rule to match the specified values.",
"default": "id"
}
}
Hide child attributes
Hide child attributes
Copy
{
"field_values": {
"type": "array",
"title": "Field Values",
"description": "List of values for the specified field.",
"minItems": 1,
"items": { "type": "string" }
}
}
Hide child attributes
Hide child attributes
Copy
{
"type": {
"type": "string",
"title": "Type",
"enum": ["bury_list"],
"default": "bury_list",
"hints": ["readonly"]
}
}
doc_type
Hide child attributes
Hide child attributes
Copy
{
"doc_type": {
"type": "string",
"title": "Doc Type",
"enum": ["rule"],
"default": "rule",
"hints": ["readonly"]
}
}
display_type
Hide child attributes
Hide child attributes
Copy
{
"display_type": {
"type": "string",
"title": "Display Type",
"enum": ["Bury List"],
"default": "Bury List",
"hints": ["readonly"]
}
}
additionalProperties
Hide child attributes
Hide child attributes
Copy
{
"additionalProperties": true
}