CorrectiveActionsResource
API reference for the Corrective Actions resource.
Methods
list
List all corrective actions.
typescript
async list(options?: { findingId?: string }): Promise<CorrectiveAction[]>get
Get a single corrective action by ID.
typescript
async get(id: string): Promise<CorrectiveAction>create
Create a new corrective action.
typescript
async create(data: CreateCorrectiveActionInput): Promise<CorrectiveAction>Parameters:
typescript
interface CreateCorrectiveActionInput {
title: string;
description?: string;
status?: string;
assignee?: string;
dueDate?: string;
findingId?: string | null;
auditId?: string | null;
linkedDocuments?: string[];
}update
Update an existing corrective action.
typescript
async update(id: string, data: Partial<CreateCorrectiveActionInput>): Promise<CorrectiveAction>delete
Delete a corrective action.
typescript
async delete(id: string): Promise<void>linkToFinding
Link a corrective action to a finding.
typescript
async linkToFinding(id: string, findingId: string): Promise<void>unlinkFromFinding
Unlink a corrective action from a finding.
typescript
async unlinkFromFinding(id: string): Promise<void>Types
CorrectiveAction
typescript
interface CorrectiveAction {
id: string;
title: string;
description?: string;
status?: string;
assignee?: string;
dueDate?: string;
findingId?: string | null;
auditId?: string | null;
linkedDocuments?: string[];
tenantId?: string;
createdBy?: string;
createdAt?: string;
updatedAt?: string;
}