LabelType API

Übersicht

Die LabelType API dient zur Verwaltung von Label-Typen in Fess. Sie können Label-Typen für die Kategorisierung und Filterung von Suchergebnissen verwalten.

Basis-URL

/api/admin/labeltype

Endpunktliste

Methode Pfad Beschreibung
GET/PUT /settings Label-Typ-Liste abrufen
GET /setting/{id} Label-Typ abrufen
POST /setting Label-Typ erstellen
PUT /setting Label-Typ aktualisieren
DELETE /setting/{id} Label-Typ löschen

Label-Typ-Liste abrufen

Request

GET /api/admin/labeltype/settings
PUT /api/admin/labeltype/settings

Parameter

Response

{
  "response": {
    "status": 0,
    "settings": [
      {
        "id": "label_id_1",
        "name": "Documentation",
        "value": "docs",
        "includedPaths": ".*docs\\.example\\.com.*",
        "excludedPaths": "",
        "sortOrder": 0
      }
    ],
    "total": 5
  }
}

Label-Typ erstellen

Request

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

Request-Body

{
  "name": "News",
  "value": "news",
  "includedPaths": ".*news\\.example\\.com.*\n.*example\\.com/news/.*",
  "excludedPaths": ".*/(archive|old)/.*",
  "sortOrder": 1,
  "permissions": ["guest"]
}

Feldbeschreibungen

Response

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

Verwendungsbeispiele

Dokumentations-Label erstellen

curl -X POST "http://localhost:8080/api/admin/labeltype/setting" \
     -H "Authorization: Bearer YOUR_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
       "name": "Technical Documentation",
       "value": "tech_docs",
       "includedPaths": ".*docs\\.example\\.com.*\n.*example\\.com/documentation/.*",
       "sortOrder": 0,
       "permissions": ["guest"]
     }'

Suche mit Label

# Mit Label filtern
curl "http://localhost:8080/json/?q=search&label=tech_docs"

Referenzinformationen