Ventana de Contexto

Sustituye el contenido de un documento con el de otro

Equivale a POST https://claix.dev/replace-document. Reemplaza el contenido de document_id con el de new_content_document_id mediante un RPC. El documento fuente se elimina. Se incrementa la version del documento destino. Conserva el mismo document_id (y su espacio, si lo tiene) mientras se actualiza el contenido con una nueva extracción. Ambos documentos deben pertenecer a la cuenta de la API key. Esta llamada es gratuita: no se factura ni consume el cupo de extracciones.

post/replace-document

Request

  • Base URL: https://claix.dev
  • URL: https://claix.dev/replace-document
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Request body

document_idstring uuid required

Documento destino cuyo contenido se sustituye. Conserva su id (y su espacio, si lo tiene).

new_content_document_idstring uuid required

Documento fuente cuyo contenido se copia. Se elimina tras el swap.

Example request

{
  "document_id": "d4a1e9d2-8b1c-4f3e-9a02-8b1e9f3c7a4b",
  "new_content_document_id": "a8c3f1e0-2d4b-4a9e-8c71-5f0e2b9d6a3c"
}

Response

Contenido sustituido; el documento fuente ha sido eliminado

successboolean required

Siempre true en una respuesta 200.

swap_idstring uuid required

Identificador de la operación de swap.

document_idstring uuid required

Documento destino (id estable).

source_document_idstring uuid required

Documento fuente que se eliminó tras el swap.

file_namestring required

Nombre de archivo del documento destino.

versionnumber required

Versión incrementada tras el swap.

swaps_countnumber required

Número acumulado de sustituciones del documento destino.

messagestring required

Mensaje legible de confirmación.

Example response

{
  "success": true,
  "swap_id": "c1e7a4b2-9f0d-4e8a-b3c5-1d2e3f4a5b6c",
  "document_id": "d4a1e9d2-8b1c-4f3e-9a02-8b1e9f3c7a4b",
  "source_document_id": "a8c3f1e0-2d4b-4a9e-8c71-5f0e2b9d6a3c",
  "file_name": "factura.pdf",
  "version": 2,
  "swaps_count": 1,
  "message": "Contenido sustituido. El documento fuente ha sido eliminado."
}

Changes

No recorded changes to this operation across all 1 revision of this API.