BFF API - SOM GUI API Specification

Endpoints

Audit Logs

Overview

The Audit Logs API provides access to audit log records, allowing users to retrieve logs based on various parameters, including order identifiers, event types, and timeframes. It enables monitoring and tracking of system activities.

Get Audit Logs

GET /auditLogs

• Description: Retrieves a paginated list of audit logs based on specified filters.
• Authentication: Required (Bearer Token)
• Query Parameters:
  • orderId (string): Filter logs by internal order ID.
  • externalOrderId (string): Filter logs by external order ID.
  • eventType (string): Filter logs by event type.
  • message (string): Filter logs by message content.
  • source (string): Filter logs by source of the event.
  • target (string): Filter logs by target of the event.
  • eventDateFrom (string, date-time): Retrieve logs from a specific start date.
  • eventDateTo (string, date-time): Retrieve logs up to a specific end date.
• Responses:
  • 200 OK: Returns a JSON array of audit logs with pagination metadata.
  • 400 Bad Request: Invalid request parameters.
  • 401 Unauthorized: Missing or invalid authentication.
  • 500 Internal Server Error: Unexpected server error.

Get Audit Log Details

GET /auditLogs/{id}

• Description: Retrieves details of a specific audit log entry.
• Authentication: Required (Bearer Token)
• Path Parameters:
  • id (string, required): The unique identifier of the audit log entry.
• Responses:
  • 200 OK: Returns the details of the specified audit log entry.
  • 400 Bad Request: Invalid request parameters.
  • 401 Unauthorized: Missing or invalid authentication.
  • 404 Not Found: Audit log entry not found.
  • 500 Internal Server Error: Unexpected server error.

Security

All endpoints require authentication using a Bearer Token (JWT). Requests without a valid token will receive a 401 Unauthorized response.

This API provides a structured way to monitor system actions and track relevant changes through audit logs.