Audit Trails

Audit trails play a critical role in ensuring transparency, compliance, and trust within the DOVU OS system.

Audit trails play a critical role in ensuring transparency, compliance, and trust within the DOVU OS system. By providing a detailed record of every action and event associated with a workflow instance, these trails form the backbone of provenance tracking. Whether for visualizing credits in a marketplace or generating compliance reports, audit trails offer the insights needed to validate the integrity of credits.

Key Benefits

  1. End-to-End Provenance: Track the entire lifecycle of a credit, from its creation to issuance, transfer, and beyond. This ensures that every step in the workflow is fully traceable.

  2. Marketplace Visualization: Enable third-party marketplaces or platforms to display the complete journey of a credit, giving buyers and stakeholders confidence in its authenticity and impact.

  3. Compliance and Reporting: Provide detailed records to meet regulatory requirements or demonstrate adherence to industry standards. This is especially valuable for sustainability-focused projects.

  4. Seamless Integration: Use the audit trail data to integrate with front-end visualizations, dashboards, or external systems, enabling easy consumption of the provenance data.


How It Works

  • The Get Workflow Instance Audit Trail endpoint retrieves a chronological list of actions, events, and associated metadata for a specific workflow instance.

  • Each audit trail entry captures key information such as timestamps, user actions, workflow transitions, and schema updates.

  • The endpoint supports structured responses, including pagination and links for navigating large datasets.


Get Workflow Instance Audit Trail

get
Header parameters
AcceptstringRequiredExample: application/json
Responses
200Success
application/json
get
GET /api/v1/workflow-instances/workflow_instance_id/audit-trail HTTP/1.1
Host: 
Accept: text
{
  "data": [],
  "links": {
    "first": "http://127.0.0.1:8000/api/v1/workflow-instances/9dad3d7a-02f2-438a-b4df-3f1d983cec62/audit-trail?page=1",
    "last": "http://127.0.0.1:8000/api/v1/workflow-instances/9dad3d7a-02f2-438a-b4df-3f1d983cec62/audit-trail?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": null,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "« Previous",
        "active": false
      },
      {
        "url": "http://127.0.0.1:8000/api/v1/workflow-instances/9dad3d7a-02f2-438a-b4df-3f1d983cec62/audit-trail?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "Next »",
        "active": false
      }
    ],
    "path": "http://127.0.0.1:8000/api/v1/workflow-instances/9dad3d7a-02f2-438a-b4df-3f1d983cec62/audit-trail",
    "per_page": 15,
    "to": null,
    "total": 0
  }
}

Last updated