Classes
Enumerations
Interfaces
TypeAliases

Rate this page:

CompassScorecard

The configuration for a scorecard that can be used by components.

Property NameTypeDescription
__typenameLiteral
appliedToComponentStatsMaybe<CompassScorecardComponentStatsQueryResult>Returns statistics on applied components used for visualization.
appliedToComponentsMaybe<CompassScorecardAppliedToComponentsQueryResult>Returns a list of components to which this scorecard is applied.
changeMetadataCompassChangeMetadataContains change metadata for the scorecard.
componentLabelsMaybe<Array<CompassComponentLabel>>A collection of component labels used to filter what components the scorecard applies to.
componentTiersMaybe<Array<CompassComponentTier>>A collection of component tiers used to filter what components the scorecard applies to.
componentTypeCompassComponentTypeThe type of component to which this scorecard is restricted.
componentTypeIdStringThe type of component to which this scorecard is restricted.
componentTypeIdsArray<String>The types of components to which this scorecard is restricted to.
criteriasMaybe<Array<CompassScorecardCriteria>>The criteria used for calculating the score.
descriptionMaybe<String>The description of the scorecard.
idStringThe unique identifier (ID) of the scorecard.
importanceCompassScorecardImportanceDetermines how the scorecard will be applied by default.
nameStringThe name of the scorecard.
ownerMaybe<User>The unique identifier (ID) of the scorecard's owner.
scorecardScoreMaybe<CompassScorecardScore>Returns the calculated total score for a given component.

Rate this page: