dataConfig API

Übersicht

die dataConfig API dient zur Verwaltung der datenspeicher-Konfiguration in Fess. Sie können Crawl-Einstellungen für datenquellen wie datenbanken, CSV und JSON verwalten.

Basis-URL

/api/admin/dataconfig

Endpunktliste

Methode Pfad Beschreibung
GET /settings datenspeicher-Konfigurationsliste abrufen
GET /setting/{id} datenspeicher-Konfiguration abrufen
POST /setting datenspeicher-Konfiguration erstellen
PUT /setting datenspeicher-Konfiguration aktualisieren
dELETE /setting/{id} datenspeicher-Konfiguration löschen

datenspeicher-Konfigurationsliste abrufen

Request

GET /api/admin/dataconfig/settings

Parameter

Parameter Typ Erforderlich Beschreibung
size Integer Nein Anzahl der Einträge pro Seite (Standard: 25)
page Integer Nein Seitennummer (beginnt bei 1, Standard: 1)
name String Nein Filtern nach Konfigurationsname
handlerName String Nein Filtern nach Handler-Name
description String Nein Filtern nach Beschreibung

Response

{
  "response": {
    "status": 0,
    "settings": [
      {
        "id": "dataconfig_id_1",
        "name": "database Crawler",
        "description": "datenbank-Crawler",
        "handlerName": "databasedataStore",
        "handlerParameter": "driver=org.postgresql.driver\nurl=jdbc:postgresql://localhost/mydb",
        "handlerScript": "...",
        "boost": 1.0,
        "available": "true",
        "permissions": "{role}admin",
        "virtualHosts": "",
        "sortOrder": 0
      }
    ],
    "total": 5
  }
}

datenspeicher-Konfiguration abrufen

Request

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

Response

{
  "response": {
    "status": 0,
    "setting": {
      "id": "dataconfig_id_1",
      "name": "database Crawler",
      "description": "datenbank-Crawler",
      "handlerName": "databasedataStore",
      "handlerParameter": "driver=org.postgresql.driver\nurl=jdbc:postgresql://localhost/mydb\nusername=dbuser\npassword=dbpass",
      "handlerScript": "...",
      "boost": 1.0,
      "available": "true",
      "sortOrder": 0,
      "permissions": "{role}admin",
      "virtualHosts": ""
    }
  }
}

datenspeicher-Konfiguration erstellen

Request

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

Request-Body

{
  "name": "Product database",
  "handlerName": "databasedataStore",
  "handlerParameter": "driver=org.postgresql.driver\nurl=jdbc:postgresql://localhost/products\nusername=user\npassword=pass",
  "handlerScript": "url=\"https://example.com/product/\" + product_id\ntitle=product_name\ncontent=description",
  "boost": 1.0,
  "available": "true",
  "sortOrder": 0,
  "permissions": "{role}admin\n{role}user"
}

Feldbeschreibungen

Feld Erforderlich Beschreibung
name Ja Konfigurationsname
description Nein Beschreibung der Konfiguration
handlerName Ja Name des datenspeicher-Handlers
handlerParameter Nein Handler-Parameter (Verbindungsinformationen usw.)
handlerScript Nein datenkonvertierungsskript
boost Ja Boost-Wert für Suchergebnisse
available Ja Aktiviert/deaktiviert (Zeichenkette "true" / "false")
sortOrder Ja Anzeigereihenfolge
permissions Nein Zugriffsberechtigte Rollen (bei mehreren durch Zeilenumbrüche getrennt)
virtualHosts Nein Virtuelle Hosts (bei mehreren durch Zeilenumbrüche getrennt)

Response

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

datenspeicher-Konfiguration aktualisieren

Request

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

Request-Body

{
  "id": "existing_dataconfig_id",
  "name": "Updated Product database",
  "handlerName": "databasedataStore",
  "handlerParameter": "driver=org.postgresql.driver\nurl=jdbc:postgresql://localhost/products\nusername=user\npassword=newpass",
  "handlerScript": "url=\"https://example.com/product/\" + product_id\ntitle=product_name\ncontent=description + \" \" + features",
  "boost": 1.5,
  "available": "true",
  "sortOrder": 0,
  "versionNo": 1
}

Aktualisierungsanfragen erfordern dieselben Pflichtfelder wie beim Erstellen (name, handlerName, boost, available, sortOrder) sowie zusätzlich die folgenden Felder:

Feld Erforderlich Beschreibung
id Ja Id der zu aktualisierenden Konfiguration
versionNo Ja Versionsnummer für optimistisches Sperren (den beim Abrufen erhaltenen Wert angeben)

Response

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

datenspeicher-Konfiguration löschen

Request

dELETE /api/admin/dataconfig/setting/{id}

Response

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

Handler-Typen

Handler-Name Beschreibung
databasedataStore Verbindung zur datenbank über JdBC
CsvdataStore daten aus CSV-dateien lesen (jede Zeile wird als ein dokument verarbeitet)
CsvListdataStore CSV-dateien lesen und verarbeitete dateien automatisch löschen (eine Erweiterung von CsvdataStore mit zeitstempelbasierter Filterung)
JsondataStore daten aus JSON-dateien oder JSON-APIs lesen

Bemerkung

die verfügbaren Handler-Typen hängen von den installierten datenspeicher-Plugins ab. die oben genannten Handler sind standardmäßig enthalten. durch die Installation von datenspeicher-Plugins wie SharePoint, Slack oder Salesforce werden die entsprechenden Handler-Namen verfügbar.

Verwendungsbeispiele

datenbank-Crawl-Konfiguration

curl -X POST "http://localhost:8080/api/admin/dataconfig/setting" \
     -H "Authorization: Bearer YOUR_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
       "name": "User database",
       "handlerName": "databasedataStore",
       "handlerParameter": "driver=org.postgresql.driver\nurl=jdbc:postgresql://localhost/userdb\nusername=dbuser\npassword=dbpass\nsql=SELECT * FROM users WHERE active=true",
       "handlerScript": "url=\"https://example.com/user/\" + user_id\ntitle=username\ncontent=profile",
       "boost": 1.0,
       "available": "true",
       "sortOrder": 0
     }'

Referenzinformationen