API de General

Vision General

La API de General es para gestionar la configuracion general de Fess. Puede obtener y actualizar configuraciones relacionadas con todo el sistema.

URL Base

/api/admin/general

Lista de Endpoints

Metodo Ruta descripcion
GET / Obtener configuracion general
PUT / Actualizar configuracion general

Obtener Configuracion General

Solicitud

GET /api/admin/general

Respuesta

{
  "response": {
    "status": 0,
    "setting": {
      "crawlerdocumentMaxSize": "10485760",
      "crawlerdocumentMaxSiteLength": "50",
      "crawlerdocumentMaxFetcherSize": "3",
      "crawlerdocumentCrawlerThreadCount": "10",
      "crawlerdocumentMaxdepth": "-1",
      "crawlerdocumentMaxAccessCount": "100",
      "indexerThreaddumpEnabled": "true",
      "indexerUnprocesseddocumentSize": "1000",
      "indexerClickCountEnabled": "true",
      "indexerFavoriteCountEnabled": "true",
      "indexerWebfsMaxContentLength": "10485760",
      "indexerWebfsContentEncoding": "UTF-8",
      "queryReplaceTermWithPrefixQuery": "false",
      "queryMaxSearchResultOffset": "100000",
      "queryMaxPageSize": "1000",
      "querydefaultPageSize": "20",
      "queryAdditionaldefaultQuery": "",
      "queryGeoEnabled": "false",
      "suggestSearchLog": "true",
      "suggestdocuments": "true",
      "suggestBadWord": "true",
      "suggestPopularWordSeedLength": "1",
      "suggestPopularWordTags": "user",
      "suggestPopularWordFields": "tags",
      "suggestPopularWordExcludeWordFields": "",
      "ldapInitialContextFactory": "com.sun.jndi.ldap.LdapCtxFactory",
      "ldapSecurityAuthentication": "simple",
      "ldapProviderUrl": "ldap://localhost:389",
      "ldapBasedn": "dc=example,dc=com",
      "ldapBinddn": "",
      "ldapBindPassword": "",
      "notificationLogin": "true",
      "notificationSearchTop": "true"
    }
  }
}

Actualizar Configuracion General

Solicitud

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

Cuerpo de la Solicitud

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

descripcion de Campos

Campo descripcion
crawlerdocumentMaxSize Tamano maximo de documento a rastrear (bytes)
crawlerdocumentMaxSiteLength Longitud maxima del sitio a rastrear
crawlerdocumentMaxFetcherSize Tamano maximo del fetcher
crawlerdocumentCrawlerThreadCount Numero de hilos del rastreador
crawlerdocumentMaxdepth Profundidad maxima de rastreo (-1=ilimitado)
crawlerdocumentMaxAccessCount Numero maximo de accesos
indexerThreaddumpEnabled Habilitar volcado de hilos
indexerUnprocesseddocumentSize Numero de documentos no procesados
indexerClickCountEnabled Habilitar conteo de clics
indexerFavoriteCountEnabled Habilitar conteo de favoritos
queryReplaceTermWithPrefixQuery Conversion a consulta de prefijo
queryMaxSearchResultOffset desplazamiento maximo de resultados de busqueda
queryMaxPageSize Numero maximo de elementos por pagina
querydefaultPageSize Numero predeterminado de elementos por pagina
queryAdditionaldefaultQuery Consulta predeterminada adicional
suggestSearchLog Habilitar sugerencias desde registro de busqueda
suggestdocuments Habilitar sugerencias desde documentos
suggestBadWord Habilitar filtro de palabras prohibidas
ldapProviderUrl URL de conexion LdAP
ldapBasedn dN base de LdAP
notificationLogin Notificacion de inicio de sesion
notificationSearchTop Notificacion de busqueda principal

Respuesta

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

Ejemplos de Uso

Actualizar Configuracion del Rastreador

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"
     }'

Actualizar Configuracion de Busqueda

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"
     }'

Actualizar Configuracion de Sugerencias

curl -X PUT "http://localhost:8080/api/admin/general" \
     -H "Authorization: Bearer YOUR_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
       "suggestSearchLog": "true",
       "suggestdocuments": "true",
       "suggestBadWord": "true"
     }'

Informacion de Referencia