Documentación API

Campos de Extracción

Endpoints para actualizar los valores de campos extraídos de documentos, tanto individualmente como en lote.

PUT /api/fields/{field_id}

Actualiza el valor de un campo de extracción. Permite cambiar el valor literal, parseado y las referencias OCR.

PUT /api/fields/{field_id}

Headers

Content-Type: application/json
Authorization: Bearer JWT_TOKEN

Body (JSON)

{
  "literal": "FAC-2024-002",
  "parsed": "FAC-2024-002",
  "word_ids": ["word-uuid-1", "word-uuid-2"]
}
  • literal: (opcional) Nuevo valor literal del campo.
  • parsed: (opcional) Nuevo valor parseado/normalizado.
  • word_ids: (opcional) Lista de IDs de palabras OCR asociadas.

Ejemplos

curl -X PUT https://api-docmind.devol.es/api/fields/FIELD_ID \
  -H "Content-Type: application/json" -H "Authorization: Bearer JWT_TOKEN" \
  -d '{"literal": "FAC-2024-002", "parsed": "FAC-2024-002"}'

Respuesta

{"message": "Campo actualizado exitosamente", "field": {"id": "field-uuid", "literal": "FAC-2024-002", "parsed": "FAC-2024-002"}}

Campo actualizado con los nuevos valores.

Errores

400Bad Request

Datos inválidos.

{"error": "Datos inválidos"}
404Not Found

Campo no encontrado.

{"error": "Campo no encontrado"}

PATCH /api/fields/{field_id}

Actualiza parcialmente un campo (endpoint legacy, misma funcionalidad que PUT).

PATCH /api/fields/{field_id}

Headers

Content-Type: application/json
Authorization: Bearer JWT_TOKEN

Body (JSON)

{"literal": "nuevo valor"}
  • literal: (opcional) Nuevo valor literal.

Ejemplos

curl -X PATCH https://api-docmind.devol.es/api/fields/FIELD_ID \
  -H "Content-Type: application/json" -H "Authorization: Bearer JWT_TOKEN" \
  -d '{"literal": "nuevo valor"}'

Respuesta

{"message": "Campo actualizado exitosamente"}

Misma funcionalidad que PUT. Mantenido por compatibilidad.

Errores

404Not Found

Campo no encontrado.

{"error": "Campo no encontrado"}

POST /api/fields/bulk_update/{extraction_id}

Actualiza múltiples campos de una extracción en una sola operación.

POST /api/fields/bulk_update/{extraction_id}

Headers

Content-Type: application/json
Authorization: Bearer JWT_TOKEN

Body (JSON)

{
  "fields": [
    {"id": "field-uuid-1", "literal": "valor 1", "parsed": "valor 1"},
    {"id": "field-uuid-2", "literal": "valor 2", "parsed": 123.45}
  ]
}
  • fields: (obligatorio) Array de campos con id, literal y parsed.

Ejemplos

curl -X POST https://api-docmind.devol.es/api/fields/bulk_update/EXTRACTION_ID \
  -H "Content-Type: application/json" -H "Authorization: Bearer JWT_TOKEN" \
  -d '{"fields": [{"id": "f1", "literal": "v1", "parsed": "v1"}]}'

Respuesta

{"message": "Campos actualizados exitosamente", "updated_count": 2}

Número de campos actualizados exitosamente.

Errores

400Bad Request

Lista de campos vacía o inválida.

{"error": "Se requiere al menos un campo"}
404Not Found

Extracción no encontrada.

{"error": "Extracción no encontrada"}

POST /api/fields/verify_status_after_update/{extraction_id}

Verifica y actualiza el estado de la extracción después de editar campos. Cambia automáticamente el status si todos los campos requeridos están completos.

POST /api/fields/verify_status_after_update/{extraction_id}

Headers

Authorization: Bearer JWT_TOKEN

Ejemplos

curl -X POST https://api-docmind.devol.es/api/fields/verify_status_after_update/EXTRACTION_ID \
  -H "Authorization: Bearer JWT_TOKEN"

Respuesta

{"message": "Estado verificado", "status": "completado", "changed": true}

Indica si el estado cambió y cuál es el nuevo estado.

Errores

404Not Found

Extracción no encontrada.

{"error": "Extracción no encontrada"}

© 2025 Devol. Todos los derechos reservados.