Audit Trail API

Introduction

The Audit Trail API allows you to list all records present in the Audit Trail database. This API provides options to filter, sort, and paginate the returned results, making it easier to retrieve and analyze audit data.

Plugin information

The Audit Trail API is a crucial component for monitoring and tracking system activities within your Joget applications. It enables administrators and developers to query audit records programmatically.

Get started

Prerequisites

• You must have access to a Joget environment where the Audit Trail API is enabled.
• Basic knowledge of RESTful API usage and JSON format.

Where to get the plugin

The Audit Trail API functionality is built into Joget; no separate plugin is required.

How to install

The Audit Trail API is pre-installed with Joget. No additional installation steps are necessary.

How to use it

1. Drag and drop the Audit Trail API from the Palette to the Canvas.
2. Select the endpoints

List of API Endpoint

List audit trails

List all records present in the Audit Trail database table by default. Able to filter or sort the returned results via parameters.

URL: /auditTrails

HTTP Method: GET

Query String Parameters

Sample Response

[
  {
    "id": "4028e381697072b901697073acec0000",
    "username": "roleAnonymous",
    "appId": "appcenter",
    "appVersion": "1",
    "timestamp": "Mar 12, 2019 1:50:22 PM",
    "clazz": "org.joget.apps.workflow.security.WorkflowAuthenticationProvider",
    "method": "authenticate",
    "message": "Authentication for user admin (0:0:0:0:0:0:0:1) : true"
  },
    .....
]