Listar as auditorias

Esse endpoint permite consultar as auditorias realizadas para o originador, com possibilidade de paginação para os resultados.

Parâmetros da URL para paginação:

  • page (integer, opcional): O nº da página para paginação.
  • size (integer, opcional): A quantidade de itens a serem retornados na paginação.

Parâmetros da Requisição

Não é necessário o envio de nenhum dado no corpo da requisição.

Resposta

Em caso de sucesso será retornado um status 200 e um arquivo JSON no seguinte formato:

  • version (integer): Número da versão da entidade/objeto.
  • version_created_by (string): Hash de identificação do usuário que realizou a alteração.
  • version_created_at (datetime): Data e hora que a versão da entidade foi gerada.
  • entity_id (string/uuid v4): ID para identificação da entidade na base de dados.
  • entity_name (string): Nome da entidade/tabela que foi afetada na alteração
  • entity_snapshot (object): Objeto contendo um snapshot com todos os dados da entidade naquela versão. Por ex. se for um objeto "bussiness" será retornado todos os dados da empresa naquela snapshot.
  • entity_diff (object): Objeto contendo um detalhamento da alteração realizada na entidade em questão.
  • entity_diff -> "nome_do_campo" (object): Nome do campo que foi afetado.
  • entity_diff -> "nome_do_campo" -> type (string): Tipo da alteração realizada. Possíveis valores: "UPDATE", "DELETED"
  • entity_diff -> "nome_do_campo" -> new_value: Novo valor atualizado para o campo.
  • entity_diff -> "nome_do_campo" -> old_value: Valor do campo anterior a alteração.

Exemplo de JSON:

{
  "content": [
    {
      "version": "",
      "version_created_by": "",
      "version_created_at": "",
      "entity_id": "",
      "entity_name": "",
      "entity_snapshot": {},
      "entity_diff": {}
    },
    {
      "version": "",
      "version_created_by": "",
      "version_created_at": "",
      "entity_id": "",
      "entity_name": "",
      "entity_snapshot": {},
      "entity_diff": {}
    }
  ],
  "total_pages": "",
  "total_elements": "",
  "has_next": ""
}

Language
URL
Click Try It! to start a request and see the response here!