API FileConfig

Vue d’ensemble

L’API FileConfig permet de gerer les configurations de crawl de fichiers de Fess. Vous pouvez manipuler les configurations de crawl pour les systemes de fichiers et les dossiers partages SMB/CIFS.

URL de base

/api/admin/fileconfig

Liste des endpoints

Methode Chemin Description
GET/PUT /settings Obtention de la liste des configurations de crawl de fichiers
GET /setting/{id} Obtention d’une configuration de crawl de fichiers
POST /setting Creation d’une configuration de crawl de fichiers
PUT /setting Mise a jour d’une configuration de crawl de fichiers
DELETE /setting/{id} Suppression d’une configuration de crawl de fichiers

Obtention de la liste des configurations de crawl de fichiers

Requete

GET /api/admin/fileconfig/settings
PUT /api/admin/fileconfig/settings

Parametres

Reponse

{
  "response": {
    "status": 0,
    "settings": [
      {
        "id": "fileconfig_id_1",
        "name": "Shared Documents",
        "paths": "file://///server/share/documents",
        "includedPaths": ".*\\.pdf$",
        "excludedPaths": ".*/(temp|cache)/.*",
        "includedDocPaths": "",
        "excludedDocPaths": "",
        "configParameter": "",
        "depth": 10,
        "maxAccessCount": 1000,
        "numOfThread": 1,
        "intervalTime": 1000,
        "boost": 1.0,
        "available": true,
        "sortOrder": 0
      }
    ],
    "total": 5
  }
}

Obtention d’une configuration de crawl de fichiers

Requete

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

Reponse

{
  "response": {
    "status": 0,
    "setting": {
      "id": "fileconfig_id_1",
      "name": "Shared Documents",
      "paths": "file://///server/share/documents",
      "includedPaths": ".*\\.pdf$",
      "excludedPaths": ".*/(temp|cache)/.*",
      "includedDocPaths": "",
      "excludedDocPaths": "",
      "configParameter": "",
      "depth": 10,
      "maxAccessCount": 1000,
      "numOfThread": 1,
      "intervalTime": 1000,
      "boost": 1.0,
      "available": true,
      "sortOrder": 0,
      "permissions": ["admin"],
      "virtualHosts": [],
      "labelTypeIds": []
    }
  }
}

Creation d’une configuration de crawl de fichiers

Requete

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

Corps de la requete

{
  "name": "Local Files",
  "paths": "file:///data/documents",
  "includedPaths": ".*\\.(pdf|doc|docx|xls|xlsx)$",
  "excludedPaths": ".*/(temp|backup)/.*",
  "depth": 5,
  "maxAccessCount": 5000,
  "numOfThread": 2,
  "intervalTime": 500,
  "boost": 1.0,
  "available": true,
  "permissions": ["admin", "user"],
  "labelTypeIds": ["label_id_1"]
}

Description des champs

Reponse

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

Mise a jour d’une configuration de crawl de fichiers

Requete

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

Corps de la requete

{
  "id": "existing_fileconfig_id",
  "name": "Updated Local Files",
  "paths": "file:///data/documents",
  "includedPaths": ".*\\.(pdf|doc|docx|xls|xlsx|ppt|pptx)$",
  "excludedPaths": ".*/(temp|backup|archive)/.*",
  "depth": 10,
  "maxAccessCount": 10000,
  "numOfThread": 3,
  "intervalTime": 300,
  "boost": 1.2,
  "available": true,
  "versionNo": 1
}

Reponse

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

Suppression d’une configuration de crawl de fichiers

Requete

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

Reponse

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

Format des chemins

Protocole Format du chemin
Fichiers locaux file:///path/to/directory
Partage Windows (SMB) file://///server/share/path
SMB avec authentification smb://username:password@server/share/path
NFS file://///nfs-server/export/path

Exemples d’utilisation

Configuration de crawl pour un partage SMB

curl -X POST "http://localhost:8080/api/admin/fileconfig/setting" \
     -H "Authorization: Bearer YOUR_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
       "name": "SMB Share",
       "paths": "smb://user:pass@server/documents",
       "includedPaths": ".*\\.(pdf|doc|docx)$",
       "excludedPaths": ".*/(temp|private)/.*",
       "depth": -1,
       "maxAccessCount": 50000,
       "numOfThread": 3,
       "intervalTime": 200,
       "available": true,
       "permissions": ["guest"]
     }'

Informations complementaires