IFClite TypeScript API
    Preparing search index...

    Interface IdsReportCheckSummary

    One check (IDS specification, or information-validation rule) inside a report block (#5125): the counts and description taken straight off SpecificationResult — shortDescription is the specification's name, longDescription its optional description, so neither is invented here.

    The optional fields below are only ever written for an information validation snapshot (#6372); an IDS snapshot keeps its original shape.

    interface IdsReportCheckSummary {
        cardinality?: IdsReportCardinality;
        checked: number;
        error?: string;
        failed: number;
        id: string;
        longDescription?: string;
        passed: number;
        passRate: number;
        rules: IdsReportRuleSummary[];
        sets?: IdsReportSetRow[];
        setsTruncated?: boolean;
        severity?: "error" | "warning";
        shortDescription: string;
    }
    Index
    cardinality? checked error? failed id longDescription? passed passRate rules sets? setsTruncated? severity? shortDescription
    cardinality?: IdsReportCardinality

    How many applicable elements the rule found against its declared cardinality (#6372).

    checked: number
    error?: string

    The engine could not evaluate this check (SpecificationResult.error); printed instead of counts (#6372).

    failed: number
    id: string
    longDescription?: string
    passed: number
    passRate: number

    0-100, floor-rounded; 100 when checked is 0 (no applicable entities) — matches SpecificationResult.passRate.

    rules: IdsReportRuleSummary[]
    sets?: IdsReportSetRow[]

    Set-level results of a unique / aggregate rule (SpecificationResult.setResults, #6372).

    setsTruncated?: boolean

    The engine capped sets before every set was evaluated (setResultsTruncated).

    severity?: "error" | "warning"

    'warning': this check's failures are warnings, counted apart from failures (#6372). Absent means 'error'.

    shortDescription: string

    Settings
    Member Visibility

    On This Page
    Properties