FindingsResource

API reference for the Findings resource.

Methods

list

List all standalone findings.

async list(): Promise<Finding[]>

get

Get a single finding by ID.

async get(id: string): Promise<Finding>

create

Create a new finding.

async create(data: CreateFindingInput): Promise<Finding>

Parameters:

interface CreateFindingInput {
  title?: string;
  description: string;
  severity?: 'low' | 'medium' | 'high' | 'critical';
  status?: string;
  assignee?: string;
  dueDate?: string;
  control?: string;
  linkedDocuments?: string[];
  auditId?: string | null;
}

update

Update an existing finding.

async update(id: string, data: Partial<CreateFindingInput>): Promise<Finding>

delete

Delete a finding.

async delete(id: string): Promise<void>

Types

Finding

interface Finding {
  id: string;
  title?: string;
  description: string;
  severity?: 'low' | 'medium' | 'high' | 'critical';
  status?: string;
  assignee?: string;
  dueDate?: string;
  control?: string;
  linkedDocuments?: string[];
  auditId?: string | null;
  origin?: 'audit' | 'standalone';
  tenantId?: string;
  createdBy?: string;
  createdAt?: string;
  updatedAt?: string;
}