Definition

Form Audit Trail API will list all form events captured by the Form Data Audit Trail plugin for the current app.

This API must be used in conjunction with the Form Data Audit Trail plugin via Plugin Default Properties.

This API is based on the current app context.


NameDescription
1List 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.

Name

Description
URL/formAuditTrails
HTTP MethodGET
Query String Parameters
ParameterDescription
search

Filters the response by querying the search terms for:

  • form ID
  • table name
  • username of user performing such action
  • form action performed
  • form data contained

Similar to the LIKE operator for database querying.

dateFrom

Filters the response from the specified date and time.

Format: YYYY-MM-DD hh:mm:ss (e.g: 2019-08-26 00:00:00)

dateTo

Filters the response to the specified date and time.

Format: YYYY-MM-DD hh:mm:ss (e.g: 2019-08-27 23:59:59)

sort

Form data audit trails data column to sort.

Must be used in conjunction with "sortDescending" parameter.

sortDescending

Sort the specified "sort" parameter value in ascending or descending order.

Expects a boolean value.

Must be used in conjunction with "sort" parameter.

startOffsetStarting position of records to start query. Expects an integer.
pageSizeNumber of results to return. Expects an integer.
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"
  },
	.....
]




  • No labels