Audit Log API

The audit log collects information on user activities within the application. These endpoints allow to post custom audit logs and to get a link to the monitor corresponding to the audit log.

Method Endpoint

POST

/cxf/bpc-auditlog/auditlog/log

Description

To create a new audit log entry, send a JSON message with the following structure:

{
    "level": "INFO",
    "originator": "[INUBIT]",
    "action": "TESTACTION",
    "description": "Only a test",
    "oldValues": "5",
    "newValues": "10",
    "externalReference": {
        "workflow": "update_units",
        "engine": "IS8"
    }
}

Hint: 'externalReference' is optional and must be a JSON object when used.

For calls from Iguasu the following HTTP headers are used and their values written to the following 'externalReference' object fields:

HTTP Header

'externalReference' field

IGUASU-System-ID

externalReference.system

IGUASU-Instance-ID

externalReference.instance

IGUASU-Processor-ID

externalReference.processor

IGUASU-Service-ID

externalReference.service

Returns

HTTP Status Code

200 : OK
400 : The transferred data is not valid
401 : Authentication could not be performed

Required Access Rights

The logged in user or API Key must have either the following role or right.

Role : AUDIT_LOG_USER
Right : AUDIT_LOG_CREATE_ENTRY

GET

/cxf/bpc-auditlog/auditlog/open/monitor

Description

Redirects the user to the monitor using the audit log OpenSearch index.

All provided query params are used to build a monitor filter on fields of the 'externalReference' object.

For Iguasu the following query parameters can be used to access the HTTP header values when the entry has been created.

Query parameter

HTTP header

system

IGUASU-System-ID

instance

IGUASU-Instance-ID

processor

IGUASU-Processor-ID

service

IGUASU-Service-ID

Returns

The requested data as JSON.

HTTP Status Code

200 : OK
401 : Authentication could not be performed
404 : Module instance was not found
500 : BPC deeplink could not be created
503 : BPC or instance are currently in maintenance mode

Content-Type

application/json

Required Access Rights

Can be used without a user session.