API General

Vue d’ensemble

L’API General permet de gerer les parametres generaux de Fess. Vous pouvez obtenir et mettre a jour les parametres globaux du systeme.

URL de base

/api/admin/general

Liste des endpoints

Methode Chemin description
GET / Obtention des parametres generaux
PUT / Mise a jour des parametres generaux

Obtention des parametres generaux

Requete

GET /api/admin/general

Reponse

{
  "response": {
    "status": 0,
    "setting": {
      "crawlerdocumentMaxSize": "10485760",
      "crawlerdocumentMaxSiteLength": "50",
      "crawlerdocumentMaxFetcherSize": "3",
      "crawlerdocumentCrawlerThreadCount": "10",
      "crawlerdocumentMaxdepth": "-1",
      "crawlerdocumentMaxAccessCount": "100",
      "indexerThreaddumpEnabled": "true",
      "indexerUnprocesseddocumentSize": "1000",
      "indexerClickCountEnabled": "true",
      "indexerFavoriteCountEnabled": "true",
      "queryMaxSearchResultOffset": "100000",
      "queryMaxPageSize": "1000",
      "querydefaultPageSize": "20",
      "suggestSearchLog": "true",
      "suggestdocuments": "true",
      "suggestBadWord": "true",
      "ldapProviderUrl": "ldap://localhost:389",
      "ldapBasedn": "dc=example,dc=com",
      "notificationLogin": "true",
      "notificationSearchTop": "true"
    }
  }
}

Mise a jour des parametres generaux

Requete

PUT /api/admin/general
Content-Type: application/json

Corps de la requete

{
  "crawlerdocumentMaxSize": "20971520",
  "crawlerdocumentMaxSiteLength": "100",
  "crawlerdocumentCrawlerThreadCount": "20",
  "queryMaxPageSize": "500",
  "querydefaultPageSize": "50",
  "suggestSearchLog": "true",
  "suggestdocuments": "true",
  "suggestBadWord": "true"
}

description des champs

Champ description
crawlerdocumentMaxSize Taille maximale des documents a crawler (octets)
crawlerdocumentMaxSiteLength Longueur maximale du site a crawler
crawlerdocumentMaxFetcherSize Taille maximale du fetcher
crawlerdocumentCrawlerThreadCount Nombre de threads du crawler
crawlerdocumentMaxdepth Profondeur maximale du crawl (-1=illimitee)
crawlerdocumentMaxAccessCount Nombre maximum d’acces
indexerClickCountEnabled Activer le comptage des clics
indexerFavoriteCountEnabled Activer le comptage des favoris
queryMaxSearchResultOffset Offset maximum des resultats de recherche
queryMaxPageSize Nombre maximum d’elements par page
querydefaultPageSize Nombre d’elements par page par defaut
suggestSearchLog Activer les suggestions depuis les logs de recherche
suggestdocuments Activer les suggestions depuis les documents
suggestBadWord Activer le filtre des mots interdits
ldapProviderUrl URL de connexion LdAP
ldapBasedn dN de base LdAP

Reponse

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

Exemples d’utilisation

Mise a jour des parametres du crawler

curl -X PUT "http://localhost:8080/api/admin/general" \
     -H "Authorization: Bearer YOUR_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
       "crawlerdocumentMaxSize": "52428800",
       "crawlerdocumentCrawlerThreadCount": "15",
       "crawlerdocumentMaxAccessCount": "1000"
     }'

Mise a jour des parametres de recherche

curl -X PUT "http://localhost:8080/api/admin/general" \
     -H "Authorization: Bearer YOUR_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
       "queryMaxPageSize": "1000",
       "querydefaultPageSize": "50",
       "queryMaxSearchResultOffset": "50000"
     }'

Informations complementaires