Project Documents Audit

This endpoint provides access to the audit trail for project document operations.

Overview

The Documents Audit API tracks all document-related activities within projects, creating a comprehensive history of document creation and deletion events. This audit trail is valuable for compliance, security monitoring, and activity tracking.

Audit Events

The system automatically records the following document events:

• Document Creation: When a new document is added to a project
• Document Deletion: When a document is removed from a project

Audit Information

Each audit record includes:

• Document ID and name
• Project ID the document belongs to
• Account ID of the user who performed the action
• Event type (create or delete)
• Timestamp of the action

Event-Driven Architecture

The audit system uses an event-driven approach, listening for document events and automatically creating audit records when documents are created or deleted. This ensures a complete and accurate history of all document operations.

Endpoints

• get /api/v3/workflow/project/documents_audit

get/api/v3/workflow/project/documents_audit

Return a paginated list of workflow/project/documents_audit

type InputSchema = {
  page?: {
    // The page number, default to 1
    number?: number;
    // The number of items per page, default to 1000
    size?: number;
  };
  // The sort order, comma separated list of fields. See sorting section for more details
  sort?: string;
  // Set to true to return the total number of items in the collection
  count?: boolean;
  filter?: {
    id?: any;
    project_id?: any;
    document_id?: any;
    document_name?: any;
    event?: any;
    created_at?: any;
    account_id?: any;
  };
  // The related resources to include in the response. Allowed resources are:
  // - `project`
  // - `document`
  included?: Array<string>;
  // The fields to include in the response.
  // The key is the resource type and the value is an array of fields.
  fields?: { [key: string]: Array<any> };
};

type OutputSchema = {
  data: Array<{
    type: string;
    id?: string;
    attributes?: {
      id?: number;
      document_name?: string;
      event?: string;
      created_at?: Date;
      account_id?: number;
    };
    relationships?: Record<string, any>;
  }>;
  included?: Array<Record<string, any>>;
};