Skip to main content

4.10. Application Administrator - View audit logs

Id 4.10.
Description As an Application Administrator

I want to have access to audit logs

So that I can find out what actions have been performed in the system and by whom
Priority High
Actors User
API Calls GET /audit-logs
GET /audit-logs/<audit_log_id>
Linked Processes
Status Implemented

Preconditions

  1. The User must be authenticated and have the Application Administrator role.

Postconditions

  1. The System returns the list of audit logs.

Main flow

  1. The Application Administrator retrieves the audit logs using the API (GET). Optionally the Application Administrator can filter logs linked to to a specific:

    • user
    • site
    • block
    • unit

    The user can also specify a time range of interest.

  2. The system validates the request parameters.

  3. The system returns the list of audit logs that match the query.

Exceptions

[400 Bad Request] Invalid input:

If mandatory fields are missing or invalid, the system returns an error message.

[404 Not found] Data not found

If the Application Administrator attempts to retrieve audit logs using filters for resources that do not exist, the system will return an error.

[500 Internal Server Error] System Error

If the system fails to save changes due to an internal error, it displays an appropriate message and logs the error for further investigation.