Get the query rewrite status - Lucidworks documentation

Get the query rewrite status

import requests

url = "https://{FUSION_HOST}/api/query-rewrite/{type}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://{FUSION_HOST}/api/query-rewrite/{type}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

require 'uri'
require 'net/http'

url = URI("https://{FUSION_HOST}/api/query-rewrite/{type}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{FUSION_HOST}/api/query-rewrite/{type}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{FUSION_HOST}/api/query-rewrite/{type}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "app": "<string>",
  "type": "<string>",
  "enabled": true,
  "numDeployed": 123,
  "collection": "<string>",
  "job": "<string>",
  "lastDeployedOn": "2023-11-07T05:31:56Z",
  "lastJobStatus": {
    "resource": "`spark:api-test-app_synonym_detection`",
    "runId": "<string>",
    "startTime": "2023-11-07T05:31:56Z",
    "endTime": "2023-11-07T05:31:56Z",
    "status": "<string>",
    "error": {},
    "extra": {},
    "startedBy": "<string>"
  }
}

GET

/

query-rewrite

/

{type}

Get the query rewrite status

import requests

url = "https://{FUSION_HOST}/api/query-rewrite/{type}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://{FUSION_HOST}/api/query-rewrite/{type}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

require 'uri'
require 'net/http'

url = URI("https://{FUSION_HOST}/api/query-rewrite/{type}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{FUSION_HOST}/api/query-rewrite/{type}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{FUSION_HOST}/api/query-rewrite/{type}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "app": "<string>",
  "type": "<string>",
  "enabled": true,
  "numDeployed": 123,
  "collection": "<string>",
  "job": "<string>",
  "lastDeployedOn": "2023-11-07T05:31:56Z",
  "lastJobStatus": {
    "resource": "`spark:api-test-app_synonym_detection`",
    "runId": "<string>",
    "startTime": "2023-11-07T05:31:56Z",
    "endTime": "2023-11-07T05:31:56Z",
    "status": "<string>",
    "error": {},
    "extra": {},
    "startedBy": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

type

string

required

The query rewrite type. Use /query-rewrite/instances to get the types for your existing query rewrites, or /query-rewrite/schema to get all possible types.

In the Fusion UI, some of these types correspond to the rewrite types in the Rewrites Manager and others correspond to action types in the Rules Manager.

Query Parameters

context

string

required

The app to which this object belongs, as app:SomeApp. If the app doesn't exist, the request fails. Other comma-separated contexts in the context parameter are allowed but ignored.

Response

200 - application/json

OK

app

string

The Fusion app to which this query rewrite belongs.

type

string

The query rewrite type.

enabled

boolean

true if this query rewrite is enabled.

numDeployed

integer<int64>

The number of deployed (published) query rewrites of this type.

collection

string

The data collection to which this query rewrite belongs.

job

string

The job type: spark, datasource, or task.

lastDeployedOn

string<date-time>

The date and time at which this query rewrite was last deployed.

lastJobStatus

object

Show child attributes