API de LabelType

Vision General

La API de LabelType es para gestionar tipos de etiqueta de Fess. Puede operar tipos de etiqueta para clasificacion y filtrado de resultados de busqueda.

URL Base

/api/admin/labeltype

Lista de Endpoints

Metodo Ruta Descripcion
GET/PUT /settings Obtener lista de tipos de etiqueta
GET /setting/{id} Obtener tipo de etiqueta
POST /setting Crear tipo de etiqueta
PUT /setting Actualizar tipo de etiqueta
DELETE /setting/{id} Eliminar tipo de etiqueta

Obtener Lista de Tipos de Etiqueta

Solicitud

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

Parametros

Respuesta

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

Obtener Tipo de Etiqueta

Solicitud

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

Respuesta

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

Crear Tipo de Etiqueta

Solicitud

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

Cuerpo de la Solicitud

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

Descripcion de Campos

Respuesta

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

Actualizar Tipo de Etiqueta

Solicitud

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

Cuerpo de la Solicitud

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

Respuesta

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

Eliminar Tipo de Etiqueta

Solicitud

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

Respuesta

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

Ejemplos de Uso

Crear Etiqueta para Documentacion

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

Busqueda Usando Etiqueta

# Filtrar por etiqueta
curl "http://localhost:8080/json/?q=search&label=tech_docs"

Informacion de Referencia