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

CompassComponent

A component represents a software development artifact tracked in Compass.

Property NameTypeDescription
__typenameLiteral
announcementsMaybe<Array<CompassAnnouncement>>A collection of announcements posted by the component.
apiMaybe<CompassComponentApi>The API spec for the component
appliedScorecardsMaybe<CompassComponentHasScorecardsAppliedConnection>### OAuth Scopes
changeMetadataCompassChangeMetadataMetadata about who created the component and when.
componentDescriptionDetailsMaybe<CompassComponentDescriptionDetails>The extended description details associated to the component
customFieldsMaybe<Array<CompassCustomField>>A collection of custom fields for storing data about the component.
dataManagerMaybe<CompassComponentDataManager>The external integration that manages data for this component.
deactivatedScorecardsMaybe<CompassDeactivatedScorecardsConnection>A collection of deactivated scorecards for this component.
descriptionMaybe<String>The description of the component.
eventSourcesMaybe<Array<EventSource>>The event sources associated to the component.
eventsMaybe<CompassEventsQueryResult>The events associated to the component.
externalAliasesMaybe<Array<CompassExternalAlias>>A collection of aliases that represent the component in external systems.
fieldsMaybe<Array<CompassField>>A collection of fields for storing data about the component.
idStringThe unique identifier (ID) of the component.
labelsMaybe<Array<CompassComponentLabel>>A collection of labels that provide additional contextual information about the component.
linksMaybe<Array<CompassLink>>A collection of links to other entities on the internet.
metricSourcesMaybe<CompassComponentMetricSourcesQueryResult>A collection of metric sources, which contain values providing numerical data about the component.
nameStringThe name of the component.
ownerIdMaybe<String>The unique identifier (ID) of the team that owns the component.
ownerTeamMaybe<TeamV2>The owner TeamV2 for the component.
packageDependenciesMaybe<CompassComponentPackageDependencyConnection>The packages this component is dependent on.
relationshipsMaybe<CompassRelationshipConnectionResult>A collection of relationships between one component with other components in Compass. Only relationships of the same direction will be returned, defaulting to OUTWARD.
scorecardScoreMaybe<CompassScorecardScore>Returns the calculated total score for a given scorecard applied to this component.
scorecardScoresMaybe<Array<CompassScorecardScore>>A collection of scorecard scores applied to a component.
scorecardsMaybe<Array<CompassScorecard>>A collection of scorecards applied to a component.
slugMaybe<String>A user-defined unique identifier for the component.
stateMaybe<String>The state of the component.
typeCompassComponentTypeThe type of component.
typeIdStringThe type of component.
typeMetadataMaybe<CompassComponentTypeObject>The additional metadata about the type of a Component.
urlMaybe<String>The URL to the component in Compass.
viewerApplicableScorecardsMaybe<CompassComponentViewerApplicableScorecardsConnection>A collection of scorecards applicable to a component by the current user.
viewerPermissionsMaybe<CompassComponentInstancePermissions>Viewer permissions specific to this component and user context.
viewerSubscriptionMaybe<CompassViewerSubscription>Component viewer subscription.

Rate this page: