REST Service Audit Logs

Rest Service Audit allows user to review audit logs for REST Service Request logs that are captured by OIPA in the Audit Log Search screen. To allow audit logs access from service layer application, set the application.enableServiceLogs property in the Service.property to Yes; however by default the value is set to NO to avoid large log collection.

View Filtered Logs

To view the REST Service audit logs, in the Audit Type drop down list select REST Service Audit, the other filter fields are updated the options available to filter the logs are User Name, Action, Service Name, HTTP Code, From, and To.

When you click Find, the REST Service Audit Result section displays the updated data. The user can search and view the filtered logs by applying the filters on the fields as follows:

Search Logs by User Name

You can search logs by User Name. By default this field is select as All such that logs of all the users are displayed.

Search Logs by Action

You can search the logs by the type of log, by action, i.e., GET, PUT, POST, DELETE, and so on. By default All is selected, such that logs related to all the Action are displayed.

Search Logs by Service Name

You can search for logs by the service name.

Search Logs by HTTP Codes

You can search the logs by the HTTP Status codes. By default All is selected, such that all the HTTP Status Codes are displayed.

Search Logs by Date Range

You can search for logs within a range of dates. The From date filter refers the oldest date and To date filter refers the latest date in the search. If the From and To dates are not mentioned then the system will it as Select All logs.

Export

The export option enables users to export data on the Rest Service Audit Result table to a file in a .xls format. The Export button is enabled only after clicking the Find button, which will populate the Rest Service Audit Result table with data.

The maximum count of rows to display is set in the application.warningcount property in the AC.properties, where the default value is set at 1000 rows; if the value of the export row count exceeds the default value, then the system will display a warning message but will allow user to proceed exporting the file after acknowledging the warning message as shown below:

"The data being exported has X,XXX,XXX rows, consider filtering the result before exporting."

Note: Here, "X,XXX,XXX" represents the actual number of rows being exported.

However, the maximum rows that a .xls excel file format can hold is 65,535 rows, this is a limitation outside of OIPA. If the records fetched by user is more than file format limit, then the system will disable the Export button and will display the warning message - "The data being exported exceeds the allowed limit for exporting to excel. Consider filtering the result before exporting."

If the exportable data has results below the threshold limit of 65,535 rows, then the system allows user to export the data by clicking the Export button and when the file is exported successfully, it display the message "File exported successfully."

The exported file will be saved in the format <AuditType_ExportDateandTime(SystemTimeStamp)>.xls

REST Service Audit Result Table

The data on REST Service Audit Results tables are in read-only in nature and table is by default, will be sortable:

  • Service Name: Name of the OIPA service that a client application is trying to fetch or execute (for example., Client, Calendar, Group Customer, and so on)
  • Action: Type of RESTful API action method (GET, PUT, POST, DELETE)
  • User Name: The unique identifier of the user who initiated the action
  • Date: Time stamp of the Service Request
  • HTTP Codes: The status code of the request response such as 200, 201, 400, 500, and so on
  • URI: The fully qualified URI (with http, server, and port info) of the service that created, made changes or requested for information from OIPA