Generate Audit Trail on Demand

You can generate the audit trail document at any time during an active workflow. With the APIs described in this article, you can inspect the data and progress of a transaction whenever necessary, e.g. in case of unexpected behavior.

Generating an audit trail involves the following steps:

1. Generate audit trail

2. Download audit trail document

Generate audit trail

The Generate Audit Trail API generates the audit trail document. When audit trail generation has finished, a notification will be sent. The generated document can then be downloaded (see Download audit trail document).

Syntax

POST /api/transactions/uuid: transaction_id/generate-audit-trail

Available parameters

Examples

Example request

The following request does not include the force parameter:

curl --location --request POST 'https://host:port/api/transactions/00178a9e-0862-4055-88b8-94f49618b51b/generate-audit-trail' \
--header 'Authorization: Bearer token' \
--header 'Cookie: cookie'

The following request includes the force parameter set to true:

curl --location --request POST 'https://host:port/api/transactions/00178a9e-0862-4055-88b8-94f49618b51b/generate-audit-trail?force=true' \
--header 'Authorization: Bearer token' \
--header 'Cookie: cookie'

Example response

The response contains the link to the download location of the audit trail document. The link has the following format:

"sfs://shared_storage_id/tenant_id/transactions/transaction_id/docs/AuditTrailDocument_transaction_version_number_events/1"

Example response if audit trail document is generated:

{
  "build_status": "in_progress",
  "path": "sfs://my_db/default/dealflo/transactions/00178a9e-0862-4055-88b8-94f49618b51b/docs/AuditTrailDocument_11_40/1"
}

Example response if audit trail document already exists:

{
  "build_status": "already_exist",
  "path": "sfs://my_db/default/dealflo/transactions/00178a9e-0862-4055-88b8-94f49618b51b/docs/AuditTrailDocument_11_40/1"
}

Notifications

Generating the audit trail document is a time-consuming operation. The status is returned as part of the response (see Example response). If the status is in_progress, the document is being created, and the SFS link will be available as soon as the document generation is completed. A notification that the document has been successfully generated will be sent to the tenant endpoint.

The notification is sent when the requested document is available for download.

• If the document already exists before a request to generate the audit trail is sent, a notification will be sent as soon as the request is completed.

• If the requested document does not exist before the request is sent, a notification will be sent to the endpoint with some delay.

Notification event content

Properties of notification event lists the properties that are included in the notification event that is sent to the tenant endpoint when audit trail generation has finished.

Example notification

{
  "timestamp": "2022-01-05T09:16:15.005Z",
  "type": "notification",
  "transaction_id": "00178a9e-0862-4055-88b8-94f49618b51b",
  "trigger": "callback_trigger",
  "skip_common_ux_components": true,
  "skip_view_state": false,
  "document_references": ["sfs://my_db/default/dealflo/transactions/00178a9e-0862-4055-88b8-94f49618b51b/docs/AuditTrailDocument_11_40/1"],
  "message": "An Audit trail has been successfully created.",
  "fields": [
    {
      "name": "callback_type",
      "value": "active"
    }
  ],
  "version": 0
}

Download audit trail document

The Download Audit Trail Document API downloads the audit trail document that was generated with Generate audit trail. The response of the generate-audit-trail request contains the link to the download location of the document. This link is included in the request to download the audit trail document.

Syntax

GET /api/transactions/uuid:transaction_id/data

Available parameters

Examples

Example request

curl --location --request GET 'https://host:port/api/transactions/00178a9e-0862-4055-88b8-94f49618b51b/data?url=sfs://my_db/default/dealflo/transactions/00178a9e-0862-4055-88b8-94f49618b51b/docs/AuditTrailDocument_11_40/1' \
--header 'Authorization: Bearer token' \
--header 'Cookie: cookie'