Member Junction
    Preparing search index...

    Class PotentialDuplicateResponse

    Response wrapper for potential duplicate searches. Includes status information and array of results. Status can be 'Inprogress' for asynchronous operations, 'Success' when complete, or 'Error' on failure.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    ErrorMessage?: string
    PotentialDuplicateResult: PotentialDuplicateResult[]

    Per-record results. For a whole-entity run this is CAPPED — see PotentialDuplicateResponse.ResultsTruncated. Every result is persisted as Duplicate Run Detail / Duplicate Run Detail Match rows regardless, so the durable record of a run is the database, not this array.

    ResultsTruncated?: boolean

    True when PotentialDuplicateResult holds fewer entries than the run actually produced, because retaining every result would grow without bound. Consumers that need the full set should read the persisted Duplicate Run Detail Match rows for the run.

    Status: "Success" | "Error" | "Inprogress"
    TotalRecordsWithDuplicates?: number

    Count of source records found to have at least one potential duplicate, across the WHOLE run. Unlike PotentialDuplicateResult.length this is never capped, so it stays correct for runs of any size. Prefer it when reporting "how many duplicates were found".