Rate this page:
A component represents a software development artifact tracked in Compass.
| Property Name | Type | Description |
|---|---|---|
| __typename | Literal | |
| announcements | Maybe<Array<CompassAnnouncement>> | A collection of announcements posted by the component. Note that the 'X-ExperimentalApi: compass-prototype' HTTP header below is required in addition to the 'X-ExperimentalApi: compass-beta' HTTP header. Set both the headers for this field. |
| applicableScorecards | Maybe<Array<CompassScorecard>> | A collection of scorecards applicable to a component. |
| changeMetadata | CompassChangeMetadata | Metadata about who created the component and when. |
| customFields | Maybe<Array<CompassCustomField>> | A collection of custom fields for storing data about the component. |
| dataManager | Maybe<CompassComponentDataManager> | The external integration that manages data for this component. |
| description | Maybe<String> | The description of the component. |
| eventSources | Maybe<Array<EventSource>> | The event sources associated to the component. |
| events | Maybe<CompassEventsQueryResult> | The events associated to the component. |
| externalAliases | Maybe<Array<CompassExternalAlias>> | A collection of aliases that represent the component in external systems. |
| fields | Maybe<Array<CompassField>> | A collection of fields for storing data about the component. |
| id | String | The unique identifier (ID) of the component. |
| labels | Maybe<Array<CompassComponentLabel>> | A collection of labels that provide additional contextual information about the component. |
| links | Maybe<Array<CompassLink>> | A collection of links to other entities on the internet. |
| metricSources | Maybe<CompassComponentMetricSourcesQueryResult> | A collection of metric sources, which contain values providing numerical data about the component. Note that the 'X-ExperimentalApi: compass-prototype' HTTP header below is required in addition to the 'X-ExperimentalApi: compass-beta' HTTP header. Set both the headers for this field. |
| name | String | The name of the component. |
| ownerId | Maybe<String> | The unique identifier (ID) of the team that owns the component. |
| relationships | Maybe<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. |
| scorecardScore | Maybe<CompassScorecardScore> | Returns the calculated total score for a given scorecard applied to this component. |
| scorecardScores | Maybe<Array<CompassScorecardScore>> | A collection of scorecard scores applied to a component. |
| scorecards | Maybe<Array<CompassScorecard>> | A collection of scorecards applied to a component. |
| type | CompassComponentType | The type of component. |
| typeId | String | The type of component. |
| viewerSubscription | Maybe<CompassViewerSubscription> | Component viewer subscription. |
Rate this page: