Member Junction
    Preparing search index...

    Interface ArchiveDocument

    The JSON document stored in external storage for each archived record version.

    interface ArchiveDocument {
        archiveConfigurationEntityId: string;
        archiveConfigurationId: string;
        archivedAt: string;
        archivedFields: Record<string, unknown>;
        archiveVersion: number;
        entityId: string;
        entityName: string;
        fullRecord: Record<string, unknown>;
        mode: string;
        primaryKey: ArchivePrimaryKeyField[];
        recordId: string;
        versionStamp: string;
    }
    Index

    Properties

    archiveConfigurationEntityId archiveConfigurationId archivedAt archivedFields archiveVersion entityId entityName fullRecord mode primaryKey recordId versionStamp

    Properties

    archiveConfigurationEntityId: string

    ID of the ArchiveConfigurationEntity that triggered this archive

    archiveConfigurationId: string

    ID of the parent ArchiveConfiguration

    archivedAt: string

    ISO 8601 timestamp when the archive was created

    archivedFields: Record<string, unknown>

    Map of field names to their archived values

    archiveVersion: number

    Schema version for forward compatibility

    entityId: string

    ID of the Entity metadata record

    entityName: string

    Name of the entity that was archived

    fullRecord: Record<string, unknown>

    Full record snapshot, or null if ArchiveFullRecord was false

    mode: string

    Archive mode (e.g. 'archive', 'purge')

    primaryKey: ArchivePrimaryKeyField[]

    Full composite primary key

    recordId: string

    Primary key value of the archived record (first key field)

    versionStamp: string

    ISO 8601 timestamp used as the version identifier

    Settings

    Member Visibility

    On This Page

    Properties