Developer
Get Support
Sign in
Get Support
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
Classes
Enumerations
Interfaces
TypeAliases

CompassScorecard

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

Property NameTypeDescription
__typenameLiteral
applicationModelCompassScorecardApplicationModelContains the application rules for how this scorecard will apply to components.
appliedToComponentsMaybe<CompassScorecardAppliedToComponentsQueryResult>Returns a list of components to which this scorecard is applied.
campaignsMaybe<CompassCampaignConnection>Returns campaigns for the scorecard
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.
componentTypeIdsArray<String>The types of components to which this scorecard is restricted to.
criteriaScoreStatisticsHistoriesMaybe<CompassScorecardCriteriaScoreStatisticsHistoryConnection>The historical score status information for scorecard criteria.
criteriasMaybe<Array<CompassScorecardCriteria>>The criteria used for calculating the score.
deactivatedComponentsMaybe<CompassScorecardDeactivatedComponentsConnection>A collection of components that deactivated this scorecard, if deactivation is enabled.
descriptionMaybe<String>The description of the scorecard.
idStringThe unique identifier (ID) of the scorecard.
importanceCompassScorecardImportanceDetermines how the scorecard will be applied by default.
isDeactivationEnabledBooleanWhether or not components can deactivate this scorecard.
libraryScorecardIdMaybe<String>The unique identifier (ID) of the library scorecard this scorecard was created from.
nameStringThe name of the scorecard.
ownerMaybe<User>The unique identifier (ID) of the scorecard's owner.
scoreSystemMaybe<CompassScorecardScoreSystem>### Field lifecycle
scorecardMaturityLevelStatisticsHistoriesMaybe<CompassScorecardMaturityLevelStatisticsHistoryConnection>### Field lifecycle
scorecardScoreMaybe<CompassScorecardScore>Returns the calculated total score for a given component.
scorecardScoreDurationStatisticsMaybe<CompassScorecardScoreDurationStatisticsResult>Score status information grouped by the number of days the status has remained unchanged.
scorecardScoreStatisticsHistoriesMaybe<CompassScorecardScoreStatisticsHistoryConnection>The historical score status information for a scorecard.
scoringStrategyTypeMaybe<String>### Field lifecycle
stateMaybe<String>The state of the scorecard.
statusConfigMaybe<CompassScorecardStatusConfig>Threshold config to calculate status for scorecard score
typeStringIndicates whether the scorecard is user-generated or pre-installed.
urlMaybe<Any>The URL to the scorecard details in Compass
verifiedMaybe<Boolean>The verification status of the scorecard
viewerPermissionsMaybe<CompassScorecardInstancePermissions>Viewer permissions specific to this scorecard and user context.

Rate this page: