prorm API Reference
    Preparing search index...

    Interface FulfillmentOptions

    Options for fulfilling a DSAR request.

    interface FulfillmentOptions {
        models?: { model: any; where?: Record<string, any> }[];
        format?: ExportFormat;
        include?: any[];
        limit?: number;
        erasureOptions?: ErasureOptions;
        exportOptions?: ExportOptions;
        notes?: string;
    }
    Index
    models?: { model: any; where?: Record<string, any> }[]

    Models to include in the data export

    format?: ExportFormat

    Export format - json, csv, or ndjson

    include?: any[]

    Include associated models in export

    limit?: number

    Maximum records per model

    erasureOptions?: ErasureOptions

    Erasure options (only for requestType: 'erasure')

    exportOptions?: ExportOptions

    Custom export options for portability requests

    notes?: string

    Notes for the fulfillment