RelatedQuery API

Übersicht

Die RelatedQuery API dient zur Verwaltung von verwandten Suchabfragen in Fess. Sie können alternative Suchbegriffe definieren, die bei bestimmten Suchanfragen vorgeschlagen werden.

Basis-URL

/api/admin/relatedquery

Endpunktliste

Methode Pfad Beschreibung
GET/PUT /settings Verwandte Abfragen Liste abrufen
GET /setting/{id} Verwandte Abfrage abrufen
POST /setting Verwandte Abfrage erstellen
PUT /setting Verwandte Abfrage aktualisieren
DELETE /setting/{id} Verwandte Abfrage löschen

Verwandte Abfrage erstellen

Request

POST /api/admin/relatedquery/setting
Content-Type: application/json

Request-Body

{
  "term": "install",
  "queries": "installation\nsetup\ninstallation guide",
  "sortOrder": 0
}

Feldbeschreibungen

Feld Erforderlich Beschreibung
term Ja Auslösender Suchbegriff
queries Ja Verwandte Abfragen (durch Zeilenumbruch getrennt)
sortOrder Nein Anzeigereihenfolge

Verwendungsbeispiele

curl -X POST "http://localhost:8080/api/admin/relatedquery/setting" \
     -H "Authorization: Bearer YOUR_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
       "term": "download",
       "queries": "downloads\nget started\ninstallation",
       "sortOrder": 0
     }'

Referenzinformationen