Référence de l’API d’administration

L’API d’administration Fess est une API RESTful permettant d’accéder aux fonctions d’administration par programmation.

Vue d'ensemble

Vue d’ensemble de l’API Admin

• Vue d’ensemble
• URL de base
• Authentification
• Patterns communs
• Format des réponses
• APIs disponibles
• Planificateur
• Gestion des utilisateurs et des droits
• Optimisation de la recherche
• Système
• Dictionnaire
• Exemples d’utilisation
• Informations complémentaires

Configuration du crawl

WebConfig API

• Vue d’ensemble
• URL de base
• Liste des endpoints
• Obtention de la liste des configurations de crawl Web
• Obtention d’une configuration de crawl Web
• Création d’une configuration de crawl Web
• Mise à jour d’une configuration de crawl Web
• Suppression d’une configuration de crawl Web
• Exemples de patterns d’URL
• Exemples d’utilisation
• Informations complémentaires

FileConfig API

• Vue d’ensemble
• URL de base
• Liste des endpoints
• Obtention de la liste des configurations de crawl de fichiers
• Obtention d’une configuration de crawl de fichiers
• Création d’une configuration de crawl de fichiers
• Mise à jour d’une configuration de crawl de fichiers
• Suppression d’une configuration de crawl de fichiers
• Format des chemins
• Exemples d’utilisation
• Informations complémentaires

API DataConfig

• Vue d’ensemble
• URL de base
• Liste des endpoints
• Obtention de la liste des configurations datastore
• Obtention d’une configuration datastore
• Création d’une configuration datastore
• Mise à jour d’une configuration datastore
• Suppression d’une configuration datastore
• Types de gestionnaires
• Exemples d’utilisation
• Informations complémentaires

Gestion de l'index

Documents API

• Vue d’ensemble
• URL de base
• Authentification
• Liste des endpoints
• Enregistrement en masse de documents
• Exemples d’utilisation
• Informations complémentaires

API CrawlingInfo

• Vue d’ensemble
• URL de base
• Liste des endpoints
• Obtention de la liste des informations de crawl
• Obtention d’une information de crawl
• Suppression d’une information de crawl
• Suppression groupée des sessions de crawl
• Exemples d’utilisation
• Informations complémentaires

API FailureUrl

• Vue d’ensemble
• URL de base
• Liste des endpoints
• Obtention de la liste des URLs en échec
• Obtention d’une URL en échec
• Suppression d’une URL en échec
• Suppression de toutes les URLs en échec
• Types d’erreurs
• Exemples d’utilisation
• Informations complémentaires

API Backup

• Vue d’ensemble
• URL de base
• Authentification
• Liste des endpoints
• Obtention de la liste des cibles de sauvegarde
• Téléchargement d’un fichier de sauvegarde
• Exemples d’utilisation
• Informations complémentaires

Planificateur

API Scheduler

• Vue d’ensemble
• URL de base
• Liste des endpoints
• Obtention de la liste des tâches planifiées
• Obtention d’une tâche planifiée
• Création d’une tâche planifiée
• Mise à jour d’une tâche planifiée
• Suppression d’une tâche planifiée
• Démarrage d’une tâche
• Arrêt d’une tâche
• Exemples d’utilisation
• Informations complémentaires

API JobLog

• Vue d’ensemble
• URL de base
• Liste des endpoints
• Obtention de la liste des journaux de tâches
• Obtention d’un journal de tâche
• Suppression d’un journal de tâche
• Exemples d’utilisation
• Informations complémentaires

Gestion des utilisateurs et des droits

User API

• Vue d’ensemble
• URL de base
• Liste des endpoints
• Lister les utilisateurs
• Récupérer un utilisateur
• Créer un utilisateur
• Mettre à jour un utilisateur
• Supprimer un utilisateur
• Exemples d’utilisation
• Références

API Role

• Vue d’ensemble
• URL de base
• Liste des endpoints
• Obtention de la liste des rôles
• Obtention d’un rôle
• Création d’un rôle
• Mise à jour d’un rôle
• Suppression d’un rôle
• Exemples d’utilisation
• Informations complémentaires

API Group

• Vue d’ensemble
• URL de base
• Liste des endpoints
• Obtention de la liste des groupes
• Obtention d’un groupe
• Création d’un groupe
• Mise à jour d’un groupe
• Suppression d’un groupe
• Exemples d’utilisation
• Informations complémentaires

AccessToken API

• Vue d’ensemble
• URL de base
• Liste des endpoints
• Obtention de la liste des jetons d’accès
• Obtention d’un jeton d’accès
• Création d’un jeton d’accès
• Mise à jour d’un jeton d’accès
• Suppression d’un jeton d’accès
• Exemples d’utilisation
• Informations complémentaires

Optimisation de la recherche

LabelType API

• Vue d’ensemble
• URL de base
• Liste des endpoints
• Obtention de la liste des types de labels
• Obtention d’un type de label
• Création d’un type de label
• Mise à jour d’un type de label
• Suppression d’un type de label
• Exemples d’utilisation
• Informations complémentaires

KeyMatch API

• Vue d’ensemble
• URL de base
• Liste des endpoints
• Obtention de la liste des KeyMatch
• Obtention d’un KeyMatch
• Création d’un KeyMatch
• Mise à jour d’un KeyMatch
• Suppression d’un KeyMatch
• Exemples d’utilisation
• Informations complémentaires

BoostDoc API

• Vue d’ensemble
• URL de base
• Authentification
• Liste des endpoints
• Obtention de la liste des boosts de documents
• Obtention d’un boost de document
• Création d’un boost de document
• Mise à jour d’un boost de document
• Suppression d’un boost de document
• Expressions de condition et de valeur de boost
• Exemples d’utilisation
• Informations complémentaires

ElevateWord API

• Vue d’ensemble
• URL de base
• Liste des endpoints
• Obtention de la liste des mots élevés
• Obtention d’un mot élevé
• Création d’un mot élevé
• Mise à jour d’un mot élevé
• Suppression d’un mot élevé
• Téléversement CSV des mots élevés
• Téléchargement CSV des mots élevés
• Exemples d’utilisation
• Informations complémentaires

API BadWord

• Vue d’ensemble
• URL de base
• Liste des endpoints
• Obtention de la liste des mots interdits
• Obtention d’un mot interdit
• Création d’un mot interdit
• Mise à jour d’un mot interdit
• Suppression d’un mot interdit
• Téléversement CSV des mots interdits
• Téléchargement CSV des mots interdits
• Exemples d’utilisation
• Informations complémentaires

RelatedContent API

• Vue d’ensemble
• URL de base
• Liste des endpoints
• Lister les contenus associés
• Obtenir un contenu associé
• Creer un contenu associé
• Mettre à jour un contenu associé
• Supprimer un contenu associé
• Exemples d’utilisation
• Informations complémentaires

RelatedQuery API

• Vue d’ensemble
• URL de base
• Liste des endpoints
• Obtention de la liste des requêtes associées
• Obtention d’une requête associée
• Création d’une requête associée
• Mise à jour d’une requête associée
• Suppression d’une requête associée
• Réponse d’erreur
• Exemples d’utilisation
• Informations complémentaires

Suggest API

• Vue d’ensemble
• Authentification
• URL de base
• Liste des endpoints
• Obtention des informations statistiques sur les mots de suggestion
• Suppression de tous les mots de suggestion
• Suppression des mots de suggestion issus des documents
• Suppression des mots de suggestion issus des requêtes de recherche
• Réponse d’erreur
• Exemples d’utilisation
• Informations complémentaires

Système

API General

• Vue d’ensemble
• URL de base
• Liste des endpoints
• Obtention des paramètres généraux
• Mise à jour des paramètres généraux
• Exemples d’utilisation
• Informations complémentaires

API SystemInfo

• Vue d’ensemble
• URL de base
• Liste des endpoints
• Obtention des informations système
• Exemples d’utilisation
• Informations complémentaires

API Stats

• Vue d’ensemble
• URL de base
• Liste des endpoints
• Obtention des statistiques système
• Exemples d’utilisation
• Informations complémentaires

Log API

• Vue d’ensemble
• URL de base
• Authentification
• Liste des endpoints
• Obtention de la liste des fichiers journaux
• Téléchargement d’un fichier journal
• Exemples d’utilisation
• Informations complémentaires

Storage API

• Vue d’ensemble
• URL de base
• Authentification
• Liste des endpoints
• Obtention de la liste des fichiers et répertoires
• Téléchargement d’un fichier
• Suppression d’un fichier
• Envoi d’un fichier
• Erreurs
• Exemples d’utilisation
• Informations complémentaires

API Plugin

• Vue d’ensemble
• URL de base
• Liste des endpoints
• Champs des informations de plugin
• Obtention de la liste des plugins installés
• Obtention de la liste des plugins installables
• Installation d’un plugin
• Suppression d’un plugin
• Exemples d’utilisation
• Informations complémentaires

Dictionnaire

API Dict

• Vue d’ensemble
• URL de base
• Liste des endpoints
• Obtention de la liste des dictionnaires
• Obtention de la liste des entrées de dictionnaire
• Obtention d’une entrée de dictionnaire
• Création d’une entrée de dictionnaire
• Mise à jour d’une entrée de dictionnaire
• Suppression d’une entrée de dictionnaire
• Téléversement d’un fichier de dictionnaire
• Téléchargement d’un fichier de dictionnaire
• Champs des entrées par type de dictionnaire
• Exemples d’utilisation
• Informations complémentaires

Journal de recherche

SearchList API

• Vue d’ensemble
• URL de base
• Authentification
• Liste des endpoints
• Recherche de documents
• Obtention d’un document
• Création d’un document
• Mise à jour d’un document
• Suppression d’un document (par ID)
• Suppression de documents (par requête)
• Codes de statut
• Exemples d’utilisation
• Informations complémentaires