Class ScorecardScoreAttributes

Attributes of a scorecard score.

Hierarchy

  • ScorecardScoreAttributes

Constructors

constructor

Properties

additionalProperties? aggregation? denominator? level? numerator? score? totalEntities? totalFail? totalNoData? totalPass? totalSkip?

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Optional aggregation

aggregation?: ScorecardScoresAggregation

Dimension to group scores by.

Optional denominator

denominator?: number

The denominator used to compute the score ratio.

Optional level

level?: number

The maturity level of the associated rule.

Optional numerator

numerator?: number

The numerator used to compute the score ratio.

Optional score

score?: number

The computed score ratio (numerator/denominator), from 0 to 1.

Optional totalEntities

totalEntities?: number

The total number of entities evaluated.

Optional totalFail

totalFail?: number

The number of rules that failed.

Optional totalNoData

totalNoData?: number

The number of rules with no data.

Optional totalPass

totalPass?: number

The number of rules that passed.

Optional totalSkip

totalSkip?: number

The number of rules that were skipped.

Settings

Member Visibility

Theme

Generated using TypeDoc