Interface RestoreOptions

Options for restoring to a version label.

interface RestoreOptions {
    CreatePreRestoreLabel?: boolean;
    DryRun?: boolean;
    Scope?: "Full" | "Selected";
    SelectedRecords?: { EntityName: string; RecordID: string }[];
    SkipEntities?: string[];
}

Properties

CreatePreRestoreLabel?: boolean

Auto-create a "before restore" label as safety net (default: true)

DryRun?: boolean

Preview only, don't actually apply changes (default: false)

Scope?: "Full" | "Selected"

Restore all items or only selected records

SelectedRecords?: { EntityName: string; RecordID: string }[]

When Scope is Selected, the records to restore

SkipEntities?: string[]

Entities to exclude from restore