Endpoints para Historial de Eliminados

Para asegurar la integridad de los datos en el contexto de nuestra API, se almacena en la base de datos un historial de los registros eliminados. Esto sirve para recuperar registros eliminados por accidente y llevar un control sobre las operaciones de borrado de datos.

Características Comunes de Historial de Eliminados

1. Identificación Única: Cada entidad de este tipo incluye un identificador único que lo distingue de los demás.

2. Datos incluidos en Historial de Eliminados: Las entidades de este tipo almacenan información sobre la el id de la entidad eliminada en la base de datos local columnId o remota columnIdRemote. También almacena el nombre de la tabla en la que se realizó la operación de borrado table y la fecha de creación del registro de borrado createdAt.

3. Entidades con Historial de Eliminados: Actualmente, todas las entidades con endpoints que utilizan el método DELETE quedan registradas en el sistema. Por ejemplo, al eliminar una compañía a través del método Delete Company.

Endpoints

GET/DeletedHistory/getDeleted

Recupera una lista con todos los registros en el historial de eliminados en la base de datos.

Descripción

Devuelve una lista paginada con todos los registros existentes en el historial de eliminados. Las opciones de paginación se pueden modificar a través de los parámetros descritos en el siguiente punto.

Parámetros

Nombre	Descripción	Tipo	Valor Predeterminado
page	Número de página	Integer	1
pageSize	Número de ítems por página	Integer	10

Respuestas

JSON

{
  "data": [
      {
      "id": "string",
      "columnId": "string",
      "columnIdRemote": "string",
      "table": "string",
      "createdAt": "string"
      }
  ],
  "pagination": {
      "totalItems": 0,
      "itemsPerPage": 0,
      "currentPage": 0,
      "totalPages": 0,
      "nextPageUrl": "string"
  }
}

XML

<?xml version="1.0" encoding="UTF-8"?>
<export>
  <data>
    <item>
      <id>string</id>
      <columnId>string</columnId>
      <columnIdRemote>string</columnIdRemote>
      <table>string</table>
      <createdAt>string</createdAt>
    </item>
  </data>
  <pagination>
    <totalItems>0</totalItems>
    <itemsPerPage>0</itemsPerPage>
    <currentPage>0</currentPage>
    <totalPages>0</totalPages>
    <nextPageUrl>string</nextPageUrl>
  </pagination>
</export>      

👉Prueba este endpoint🌱

GET/DeletedHistory/updatedFrom

Recupera una lista con todos los registros en el historial de eliminados en la base de datos desde la fecha proporcionada en los parámetros.

Descripción

Devuelve una lista paginada con todos los registros existentes en el historial de eliminados desde la fecha indicada. Las opciones de paginación y fecha se pueden modificar a través de los parámetros descritos en el siguiente punto.

Parámetros

Nombre	Descripción	Tipo	Valor por defecto
date	Última modificación	String	1999-01-01 01:00:00
page	Número de página	Integer	1
pageSize	Elementos por página	Integer	10

Respuestas

JSON

{
  "data": [
      {
      "id": "string",
      "columnId": "string",
      "columnIdRemote": "string",
      "table": "string",
      "createdAt": "string"
      }
  ],
  "pagination": {
      "totalItems": 0,
      "itemsPerPage": 0,
      "currentPage": 0,
      "totalPages": 0,
      "nextPageUrl": "string"
  }
}

XML

<?xml version="1.0" encoding="UTF-8"?>
<export>
  <data>
    <item>
      <id>string</id>
      <columnId>string</columnId>
      <columnIdRemote>string</columnIdRemote>
      <table>string</table>
      <createdAt>string</createdAt>
    </item>
  </data>
  <pagination>
    <totalItems>0</totalItems>
    <itemsPerPage>0</itemsPerPage>
    <currentPage>0</currentPage>
    <totalPages>0</totalPages>
    <nextPageUrl>string</nextPageUrl>
  </pagination>
</export>   

👉Prueba este endpoint🌱

Posibles Errores de Respuesta

Error	Código	Respuesta
Este error ocurre cuando no se puede establecer una conexión con la base de datos. Es un problema interno del servidor.	500	{"code": 500,"error": "Database connection failed."}
Este error ocurre cuando no puede insertar o actualizar y en la dbs de pruebas.	500	{"code": 500,"error": "Invalid connection name, you cannot insert in default"}
Este error indica que el servidor rechaza la solicitud.	400	{"code": 400,"error": "Bad Request"}
Este error indica que no está autorizado.	401	{"code": 401,"error": "Unauthorized."}
Este error indica que no ha sido posible encontrar el registro.	404	{"code": 404,"error": "No entity found for DeletedHistory with $id."}
Este error ocurre cuando intenta enviar demasiadas solicitudes en un corto periodo de tiempo.	429	{"code": 429,"error": "Too Many Requests"}