Circle V2 API Docs
    Preparing search index...
    type ConditionalRuleProposal = {
        description: string;
        id: string;
        kind: ConditionalRuleKind;
        sourceFieldRef: string | null;
        targetFieldRef: string | null;
    }
    Index

    Properties

    description: string

    What the rule says, as text a reviewer can judge — the vendor's words, or compact JSON.

    id: string

    Unique within ONE detection payload and nothing more. Never persist it as an identity.

    sourceFieldRef: string | null

    The vendor property key of the field the rule conditions ON, when one could be read.

    targetFieldRef: string | null

    The vendor property key of the field the rule acts on, when one could be read.