Form Audit Trail API

Introduction

The Form Audit Trail API lists all form events captured by the current application's Form Data Audit Trail plugin. This API lets you track and review user interactions with forms within your Joget app.

Plugin information

The Form Audit Trail API works in conjunction with the Form Data Audit Trail plugin. To utilize the API effectively, this plugin must be configured via Plugin Default Properties.

Get started

Prerequisites

• You must have the Form Data Audit Trail plugin installed and configured in your Joget app.
• Familiarity with using RESTful APIs and JSON format is recommended.

Where to get the plugin

You can download the Form Data Audit Trail plugin from the Joget Marketplace.

How to install

• Install the plugin through the Joget Plugin Manager.
• Configure the Plugin Default Properties to enable audit trail data capture.

How to use it

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

List of API Endpoints

List form data audit trails

List all form events captured by the Form Data Audit Trail plugin for the current app.

Able to filter or sort the returned results via parameters.

URL: /formAuditTrails

HTTP Method: GET

Query String Parameters

Sample Response

[
  {
    "id": "d708f060-c0a86310-60e35ca0-2e253741",
    "appId": "expenseclaim",
    "appVersion": "1",
    "formId": "ExpensesClaim",
    "tableName": "j_expense_claim",
    "username": "admin",
    "action": "loadWithoutTransaction",
    "data": "141_expenseclaim_process1",
    "datetime": "Aug 28, 2019 2:03:03 PM"
  },
    .....
]