Result interface

Properties

dependencyResult

Additional information about the alert. Valid when ResultType is Dependency

fingerprint

Full fingerprint of the Result. This is used to detect duplicate instances of the same alert

fingerprintId

Unique ID of the fingerprint of the Result

resultId

Unique ID of the Result

resultIndex

This is the index into the SARIF Results array. If we have to do any tool specific insertions, we'll use this key to index back into the SARIF Results array.

resultMessage

Detailed description of the rule that triggered the alert

resultType

The type of rule that triggered the alert

ruleId

ID of the rule that the triggered the alert

ruleShortDescription

Short description of the rule that triggered the alert

severity

The severity of the alert

versionControlResult

Additional information about the alert. Valid when ResultType is VersionControl

Property Details

dependencyResult

Additional information about the alert. Valid when ResultType is Dependency

dependencyResult: DependencyResult

Property Value

fingerprint

Full fingerprint of the Result. This is used to detect duplicate instances of the same alert

fingerprint: string

Property Value

string

fingerprintId

Unique ID of the fingerprint of the Result

fingerprintId: number

Property Value

number

resultId

Unique ID of the Result

resultId: number

Property Value

number

resultIndex

This is the index into the SARIF Results array. If we have to do any tool specific insertions, we'll use this key to index back into the SARIF Results array.

resultIndex: number

Property Value

number

resultMessage

Detailed description of the rule that triggered the alert

resultMessage: string

Property Value

string

resultType

The type of rule that triggered the alert

resultType: ResultType

Property Value

ruleId

ID of the rule that the triggered the alert

ruleId: number

Property Value

number

ruleShortDescription

Short description of the rule that triggered the alert

ruleShortDescription: string

Property Value

string

severity

The severity of the alert

severity: Severity

Property Value

versionControlResult

Additional information about the alert. Valid when ResultType is VersionControl

versionControlResult: VersionControlResult

Property Value