go back to AuditTransactionService

GET /auditTransactions/search

Searches the database for Audit log transactions matching the given request parameters.

Roles that can access this endpoint are Users.

Parameters

name description type default type
excludeAdd Provide true value to exclude any newly created records in response results (i.e. excludeAdd=true). Defaults to false if no parameter provided. query false boolean
excludeDelete Provide true value to exclude any deleted records in response results (i.e. excludeDelete=true). Defaults to false if no parameter provided. query false boolean
excludeUpdate Provide true value to exclude any updated records in response results (i.e. excludeDelete=true). Defaults to false if no parameter provided. query false boolean
request read for query parameters to be used as search criteria; use any combination of fields from the audit_log_tx table using a prefix of audit_log_tx or no prefix.

Notes:
  • Audit transactions are limited to the audit_log_tx table which only retains one day of transactions based upon purge settings in the McLeod application.
  • changed_values field search will find any matching part of the changed value string. (i.e. changed_values=status|A|P)


For example, /auditTransactions/search?audit_log_tx.table_name=orders&change_date_time=%3E%3D10/05/2021%20143000&audit_log_tx.changed_values=status%7CA%7CP would find all audit transactions for orders where the status changed from A (Available) to P (In Progress) from the timestamp 04/14/2022 20:14:30

Sorting: To sort the result set, you can provide the following reserved query parameter: orderBy If the orderBy parameter is not provided a default sort of location.id+ASC will be applied.

For example, /auditTransactions/search?audit_log_tx.table_name=orders&orderBy=audit_log_tx.changed_date_time+DESC would return all audit log transaction records for order changes sorted descending by the changed date/time. Multiple sort columns can be provided in a comma delimited format. orderBy=prefix.field+direction,prefix.field+direction

Pagination: To page the result set, you can provide the following reserved query parameters: recordLength and recordOffset

For example, /auditTransactions/search?audit_log_tx.table_name=orders&recordLength=100&recordOffset=50 would return 100 records starting at the 51st record in the return record set. If no recordLength parameter is provided the search result maximum value in the mobile service control file will be applied.

context HttpServletRequest

Result

List < RowAuditLogTx > of type: application/xml application/json

a list of RowLocation objects

Try It Out

Request

- Authentication Help
- boolean
- boolean
- boolean