ElevateWord API

Übersicht

Die ElevateWord API dient zur Verwaltung von Elevate Words (Beeinflussung des Suchrangs für bestimmte Schlüsselwörter) in Fess. Für bestimmte Suchanfragen können Sie bestimmte Dokumente höher oder niedriger platzieren.

Basis-URL

/api/admin/elevateword

Endpunktliste

Methode Pfad Beschreibung
GET /settings Elevate Word Liste abrufen
GET /setting/{id} Elevate Word abrufen
POST /setting Elevate Word erstellen
PUT /setting Elevate Word aktualisieren
DELETE /setting/{id} Elevate Word löschen
POST /upload Elevate Word CSV hochladen
GET /download Elevate Word CSV herunterladen

Elevate Word Liste abrufen

Request

GET /api/admin/elevateword/settings

Parameter

Parameter Typ Erforderlich Beschreibung
size Integer Nein Anzahl der Einträge pro Seite (Standard: 25; änderbar über paging.page.size in fess_config.properties)
page Integer Nein Seitennummer (beginnt bei 1, Standard: 1)
id String Nein Exact-Match-Filter nach Elevate-Word-ID

Diese Parameter werden im JSON-Anfragekörper angegeben (z. B. {"size": 50, "page": 1}). Werte in der URL-Query-String (z. B. ?size=50) werden ignoriert; ohne Angabe im Anfragekörper werden daher immer die ersten 25 Einträge zurückgegeben.

Response

{
  "response": {
    "status": 0,
    "settings": [
      {
        "id": "elevate_id_1",
        "suggest_word": "fess",
        "reading": "",
        "permissions": "{role}guest",
        "boost": 100.0,
        "label_type_ids": []
      }
    ],
    "total": 5
  }
}

Elevate Word abrufen

Request

GET /api/admin/elevateword/setting/{id}

Response

{
  "response": {
    "status": 0,
    "setting": {
      "id": "elevate_id_1",
      "suggest_word": "fess",
      "reading": "",
      "permissions": "{role}guest",
      "boost": 100.0,
      "label_type_ids": []
    }
  }
}

Elevate Word erstellen

Request

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

Request-Body

{
  "suggest_word": "documentation",
  "reading": "",
  "permissions": "{role}guest",
  "boost": 100.0,
  "label_type_ids": ["label1"]
}

Feldbeschreibungen

Feld Erforderlich Beschreibung
suggest_word Ja Das hervorzuhebende Schlüsselwort
reading Nein Lesehilfe (Kana)
permissions Nein Zugriffsberechtigungen (durch Zeilenumbrüche getrennte Zeichenkette, ein Eintrag pro Zeile. Formular-Standardwert: Standard-Anzeigeberechtigung der Suche)
boost Ja Boost-Wert (Formular-Standardwert: 100.0)
label_type_ids Nein Ziel-Label-IDs (Array von Zeichenketten)

Response

{
  "response": {
    "status": 0,
    "id": "new_elevate_id",
    "created": true
  }
}

Elevate Word aktualisieren

Request

PUT /api/admin/elevateword/setting
Content-Type: application/json

Request-Body

{
  "id": "existing_elevate_id",
  "suggest_word": "documentation",
  "reading": "",
  "permissions": "{role}guest\n{role}user",
  "boost": 100.0,
  "label_type_ids": ["label1"],
  "version_no": 1
}

Bemerkung

Bei einer Aktualisierung sind zusätzlich zu den Feldern, die bei der Erstellung verwendet werden, folgende Felder erforderlich:

  • id - ID des zu aktualisierenden Elevate Words

  • version_no - Versionsnummer für optimistisches Sperren. Geben Sie den Wert an, der über GET /setting/{id} abgerufen wurde.

Response

{
  "response": {
    "status": 0,
    "id": "existing_elevate_id",
    "created": false
  }
}

Elevate Word löschen

Request

DELETE /api/admin/elevateword/setting/{id}

Response

{
  "response": {
    "status": 0,
    "id": "deleted_elevate_id",
    "created": false
  }
}

Elevate Word CSV hochladen

Registriert Elevate Words gesammelt aus einer CSV-Datei. Die Datei wird als multipart/form-data gesendet. Der Import wird serverseitig asynchron ausgeführt.

Request

POST /api/admin/elevateword/upload
Content-Type: multipart/form-data

Parameter

Parameter Erforderlich Beschreibung
elevateWordFile Ja Hochzuladende Elevate-Word-CSV-Datei

Response

{
  "response": {
    "status": 0
  }
}

Elevate Word CSV herunterladen

Lädt die registrierten Elevate Words als CSV-Datei (elevate.csv) herunter. Die Antwort ist ein Stream vom Typ application/octet-stream.

Request

GET /api/admin/elevateword/download

Verwendungsbeispiele

Produktnamen hervorheben

curl -X POST "http://localhost:8080/api/admin/elevateword/setting" \
     -H "Authorization: Bearer YOUR_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
       "suggest_word": "Product X",
       "boost": 100.0,
       "permissions": "{role}guest"
     }'

Hervorheben für ein bestimmtes Label

curl -X POST "http://localhost:8080/api/admin/elevateword/setting" \
     -H "Authorization: Bearer YOUR_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
       "suggest_word": "API reference",
       "boost": 100.0,
       "label_type_ids": ["technical_docs"],
       "permissions": "{role}guest"
     }'

CSV-Datei hochladen

curl -X POST "http://localhost:8080/api/admin/elevateword/upload" \
     -H "Authorization: Bearer YOUR_TOKEN" \
     -F "elevateWordFile=@elevate.csv"

CSV-Datei herunterladen

curl -X GET "http://localhost:8080/api/admin/elevateword/download" \
     -H "Authorization: Bearer YOUR_TOKEN" \
     -o elevate.csv

Referenzinformationen