Classes

Rate this page:

Type Aliases

AddCompassComponentLabelsInput

Accepts input for adding labels to a component.

Property NameTypeDescription
componentIdStringThe ID of the component to add the labels to.
labelNamesArray<String>The collection of labels to add to the component.

AddCompassComponentLabelsPayload

The payload returned after adding labels to a component.

Property NameTypeDescription
__typenameLiteral
addedLabelsMaybe<Array<CompassComponentLabel>>The collection of labels that were added to the component.
componentDetailsMaybe<CompassComponent>The details of the component that was mutated.
errorsMaybe<Array<MutationError>>A list of errors that occurred during the mutation.
successBooleanWhether the mutation was successful or not.

ApplyCompassScorecardToComponentPayload

The payload returned from applying a scorecard to a component.

Property NameTypeDescription
__typenameLiteral
componentDetailsMaybe<CompassComponent>The details of the component that was mutated.
errorsMaybe<Array<MutationError>>A list of errors that occurred during the mutation.
successBooleanWhether the mutation was successful or not.

AttachCompassComponentDataManagerInput

Accepts input to attach a data manager to a component.

Property NameTypeDescription
componentIdStringThe ID of the component to attach a data manager to.
externalSourceURLInputMaybe<Any>An URL of the external source of the component's data.

AttachCompassComponentDataManagerPayload

The payload returned from attaching a data manager to a component.

Property NameTypeDescription
__typenameLiteral
componentDetailsMaybe<CompassComponent>The details of the component that was mutated.
errorsMaybe<Array<MutationError>>A list of errors that occurred during the mutation.
successBooleanWhether the mutation was successful or not.

CompassAcknowledgeAnnouncementInput

Accepts input for acknowledging an announcement.

Property NameTypeDescription
announcementIdStringThe ID of the announcement being acknowledged.
componentIdStringThe ID of the component that is acknowledging the announcement.

CompassAcknowledgeAnnouncementPayload

The payload returned after acknowledging an announcement.

Property NameTypeDescription
__typenameLiteral
acknowledgementMaybe<CompassAnnouncementAcknowledgement>The announcement acknowledgement.
errorsMaybe<Array<MutationError>>A list of errors that occurred during the mutation.
successBooleanWhether the mutation was successful or not.

CompassAlertEvent

Property NameTypeDescription
__typenameLiteral
alertPropertiesCompassAlertEventPropertiesAlert Properties
descriptionMaybe<String>The description of the event.
displayNameStringThe name of the event.
eventTypeCompassEventTypeThe type of the event.
lastUpdatedAnyThe last time this event was updated.
updateSequenceNumberAnyA number specifying the order of the update to the event.
urlMaybe<Any>The URL of the event.

CompassAlertEventProperties

################################################################################################################### CompassAlertEventPropertiesInput The list of properties of the alert event.

Property NameTypeDescription
idStringThe ID of the alert.

CompassAnnouncement

An announcement communicates news or updates relating to a component.

Property NameTypeDescription
__typenameLiteral
acknowledgementsMaybe<Array<CompassAnnouncementAcknowledgement>>The list of acknowledgements that are required for this announcement.
componentMaybe<CompassComponent>The component that posted the announcement.
descriptionMaybe<String>The description of the announcement.
idStringThe ID of the announcement.
targetDateMaybe<Any>The date on which the updates in the announcement will take effect.
titleMaybe<String>The title of the announcement.

CompassAnnouncementAcknowledgement

Tracks whether or not a component has acknowledged an announcement.

Property NameTypeDescription
__typenameLiteral
componentMaybe<CompassComponent>The component that needs to acknowledge.
hasAcknowledgedMaybe<Boolean>Whether the component has acknowledged the announcement or not.

CompassBuildEvent

Property NameTypeDescription
__typenameLiteral
buildPropertiesCompassBuildEventPropertiesBuild Properties
descriptionMaybe<String>The description of the build event.
displayNameStringThe name of the build event.
eventTypeCompassEventTypeThe type of the event.
lastUpdatedAnyThe last time this event was updated.
updateSequenceNumberAnyA number specifying the order of the update to the event.
urlMaybe<Any>The URL of the build event.

CompassBuildEventPipeline

Property NameTypeDescription
__typenameLiteral
displayNameMaybe<String>The name of the build event pipeline.
pipelineIdStringThe ID of the build event pipeline.
urlMaybe<String>The URL to the build event pipeline.

CompassBuildEventPipelineInput

The build event pipeline.

Property NameTypeDescription
displayNameInputMaybe<String>The name of the build event pipeline.
pipelineIdStringThe ID of the build event pipeline.
urlInputMaybe<String>The URL to the build event pipeline.

CompassBuildEventProperties

Property NameTypeDescription
__typenameLiteral
completedAtMaybe<Any>Time the build completed.
pipelineMaybe<CompassBuildEventPipeline>The build event pipeline
startedAtAnyTime the build started.
stateCompassBuildEventStateThe state of the build

CompassBuildEventPropertiesInput

The list of properties of the build event.

Property NameTypeDescription
completedAtInputMaybe<Any>Time the build completed.
pipelineCompassBuildEventPipelineInputThe build event pipeline.
startedAtAnyTime the build started.
stateCompassBuildEventStateThe state of the build.

CompassCatalogMutationApi

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
__typenameLiteral
acknowledgeAnnouncementMaybe<CompassAcknowledgeAnnouncementPayload>Acknowledges an announcement on behalf of a 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.
addComponentLabelsMaybe<AddCompassComponentLabelsPayload>Adds a collection of labels to a component.
applyScorecardToComponentMaybe<ApplyCompassScorecardToComponentPayload>Applies a scorecard to a component.
attachComponentDataManagerMaybe<AttachCompassComponentDataManagerPayload>Attach a data manager to a component.
attachEventSourceMaybe<AttachEventSourcePayload>Attaches an event source to a 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.
createAnnouncementMaybe<CompassCreateAnnouncementPayload>Creates an announcement for a 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.
createCompassEventMaybe<CompassCreateEventsPayload>Creates a compass event. 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.
createComponentMaybe<CreateCompassComponentPayload>Creates a new component.
createComponentExternalAliasMaybe<CreateCompassComponentExternalAliasPayload>Creates an external alias for a component.
createComponentLinkMaybe<CreateCompassComponentLinkPayload>Creates a link for a component.
createCustomFieldDefinitionMaybe<CompassCreateCustomFieldDefinitionPayload>Creates a custom field definition on a Compass site. A custom field definition introduces additional fields for components of the specified types. 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.
createDeploymentEventMaybe<CreateDeploymentEventsPayload>Creates a deployment event. 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.
createEventSourceMaybe<CreateEventSourcePayload>Creates an event source. 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.
createMetricDefinitionMaybe<CompassCreateMetricDefinitionPayload>Creates a metric definition on a Compass site. A metric definition provides details for a metric source. 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.
createMetricSourceMaybe<CompassCreateMetricSourcePayload>Creates a metric source for a component. A metric source contains values providing numerical data about a 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.
createRelationshipMaybe<CreateCompassRelationshipPayload>Creates a new relationship between two components.
createScorecardMaybe<CreateCompassScorecardPayload>Creates a scorecard.
createScorecardCriteriasMaybe<CreateCompassScorecardCriteriasPayload>Adds criteria to a scorecard.
createStarredComponentMaybe<CreateCompassStarredComponentPayload>Creates a starred relationship between a user and a component.
createTeamCheckinMaybe<CompassCreateTeamCheckinPayload>Creates a checkin for a team. 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.
deleteAnnouncementMaybe<CompassDeleteAnnouncementPayload>Deletes an existing announcement from a 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.
deleteComponentMaybe<DeleteCompassComponentPayload>Deletes an existing component.
deleteComponentExternalAliasMaybe<DeleteCompassComponentExternalAliasPayload>Deletes an existing external alias from a component.
deleteComponentLinkMaybe<DeleteCompassComponentLinkPayload>Deletes an existing link from a component.
deleteCustomFieldDefinitionMaybe<CompassDeleteCustomFieldDefinitionPayload>Deletes a custom field definition including all the relevant field values on components. 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.
deleteEventSourceMaybe<DeleteEventSourcePayload>Deletes an event source. 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.
deleteMetricDefinitionMaybe<CompassDeleteMetricDefinitionPayload>Deletes a metric definition including the metric sources it defines from a Compass site. Metric sources contain values providing numerical data about a 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.
deleteMetricSourceMaybe<CompassDeleteMetricSourcePayload>Deletes a metric source including the metric values it contains. 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.
deleteRelationshipMaybe<DeleteCompassRelationshipPayload>Deletes an existing relationship between two components.
deleteScorecardMaybe<DeleteCompassScorecardPayload>Deletes a scorecard.
deleteScorecardCriteriasMaybe<DeleteCompassScorecardCriteriasPayload>Deletes criteria from a scorecard.
deleteStarredComponentMaybe<DeleteCompassStarredComponentPayload>Deletes a starred relationship between a user and a component.
deleteTeamCheckinMaybe<CompassDeleteTeamCheckinPayload>Deletes a checkin from a team. 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.
detachComponentDataManagerMaybe<DetachCompassComponentDataManagerPayload>Detach a data manager from a component.
detachEventSourceMaybe<DetachEventSourcePayload>Detaches an event source from a 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.
insertMetricValueMaybe<CompassInsertMetricValuePayload>Inserts a metric value in a metric source for a 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.
insertMetricValueByExternalIdMaybe<CompassInsertMetricValueByExternalIdPayload>Inserts a metric value into every metric source that matches the provided definition ID and external ID. 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.
removeComponentLabelsMaybe<RemoveCompassComponentLabelsPayload>Removes a collection of existing labels from a component.
removeScorecardFromComponentMaybe<RemoveCompassScorecardFromComponentPayload>Removes a scorecard from a component.
synchronizeLinkAssociationsMaybe<CompassSynchronizeLinkAssociationsPayload>Synchronizes event and metric information for the current set of component links on a Compass site using the provided Forge app. 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.
unlinkExternalSourceMaybe<UnlinkExternalSourcePayload>Clean external aliases and data managers pertaining to an externalSource
updateAnnouncementMaybe<CompassUpdateAnnouncementPayload>Updates an announcement from a 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.
updateComponentMaybe<UpdateCompassComponentPayload>Updates an existing component.
updateComponentDataManagerMetadataMaybe<UpdateCompassComponentDataManagerMetadataPayload>Update a data manager of a component.
updateComponentLinkMaybe<UpdateCompassComponentLinkPayload>Updates a link from a component.
updateCustomFieldDefinitionMaybe<CompassUpdateCustomFieldDefinitionPayload>Updates a custom field definition on a Compass site 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.
updateMetricDefinitionMaybe<CompassUpdateMetricDefinitionPayload>Updates a metric definition on a Compass site. 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.
updateScorecardMaybe<UpdateCompassScorecardPayload>Updates a scorecard.
updateScorecardCriteriasMaybe<UpdateCompassScorecardCriteriasPayload>Updates criteria on a scorecard.
updateTeamCheckinMaybe<CompassUpdateTeamCheckinPayload>Updates a checkin for a team. 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.

CompassCatalogMutationApiAcknowledgeAnnouncementArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCompassAcknowledgeAnnouncementInput

CompassCatalogMutationApiAddComponentLabelsArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputAddCompassComponentLabelsInput

CompassCatalogMutationApiApplyScorecardToComponentArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
componentIdString
scorecardIdString

CompassCatalogMutationApiAttachComponentDataManagerArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputAttachCompassComponentDataManagerInput

CompassCatalogMutationApiAttachEventSourceArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputAttachEventSourceInput

CompassCatalogMutationApiCreateAnnouncementArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCompassCreateAnnouncementInput

CompassCatalogMutationApiCreateCompassEventArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCompassCreateEventInput

CompassCatalogMutationApiCreateComponentArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
cloudIdString
inputCreateCompassComponentInput

CompassCatalogMutationApiCreateComponentExternalAliasArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCreateCompassComponentExternalAliasInput

CompassCatalogMutationApiCreateComponentLinkArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCreateCompassComponentLinkInput

CompassCatalogMutationApiCreateCustomFieldDefinitionArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCompassCreateCustomFieldDefinitionInput

CompassCatalogMutationApiCreateDeploymentEventArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCreateDeploymentEventInput

CompassCatalogMutationApiCreateEventSourceArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCreateEventSourceInput

CompassCatalogMutationApiCreateMetricDefinitionArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCompassCreateMetricDefinitionInput

CompassCatalogMutationApiCreateMetricSourceArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCompassCreateMetricSourceInput

CompassCatalogMutationApiCreateRelationshipArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCreateCompassRelationshipInput

CompassCatalogMutationApiCreateScorecardArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
cloudIdString
inputCreateCompassScorecardInput

CompassCatalogMutationApiCreateScorecardCriteriasArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCreateCompassScorecardCriteriasInput
scorecardIdString

CompassCatalogMutationApiCreateStarredComponentArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
cloudIdString
inputCreateCompassStarredComponentInput

CompassCatalogMutationApiCreateTeamCheckinArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCompassCreateTeamCheckinInput

CompassCatalogMutationApiDeleteAnnouncementArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCompassDeleteAnnouncementInput

CompassCatalogMutationApiDeleteComponentArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputDeleteCompassComponentInput

CompassCatalogMutationApiDeleteComponentExternalAliasArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputDeleteCompassComponentExternalAliasInput

CompassCatalogMutationApiDeleteComponentLinkArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputDeleteCompassComponentLinkInput

CompassCatalogMutationApiDeleteCustomFieldDefinitionArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCompassDeleteCustomFieldDefinitionInput

CompassCatalogMutationApiDeleteEventSourceArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputDeleteEventSourceInput

CompassCatalogMutationApiDeleteMetricDefinitionArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCompassDeleteMetricDefinitionInput

CompassCatalogMutationApiDeleteMetricSourceArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCompassDeleteMetricSourceInput

CompassCatalogMutationApiDeleteRelationshipArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputDeleteCompassRelationshipInput

CompassCatalogMutationApiDeleteScorecardArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
scorecardIdString

CompassCatalogMutationApiDeleteScorecardCriteriasArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputDeleteCompassScorecardCriteriasInput
scorecardIdString

CompassCatalogMutationApiDeleteStarredComponentArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
cloudIdString
inputDeleteCompassStarredComponentInput

CompassCatalogMutationApiDeleteTeamCheckinArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCompassDeleteTeamCheckinInput

CompassCatalogMutationApiDetachComponentDataManagerArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputDetachCompassComponentDataManagerInput

CompassCatalogMutationApiDetachEventSourceArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputDetachEventSourceInput

CompassCatalogMutationApiInsertMetricValueArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCompassInsertMetricValueInput

CompassCatalogMutationApiInsertMetricValueByExternalIdArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCompassInsertMetricValueByExternalIdInput

CompassCatalogMutationApiRemoveComponentLabelsArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputRemoveCompassComponentLabelsInput

CompassCatalogMutationApiRemoveScorecardFromComponentArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
componentIdString
scorecardIdString

CompassCatalogMutationApiSynchronizeLinkAssociationsArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputInputMaybe<CompassSynchronizeLinkAssociationsInput>

CompassCatalogMutationApiUnlinkExternalSourceArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputUnlinkExternalSourceInput

CompassCatalogMutationApiUpdateAnnouncementArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCompassUpdateAnnouncementInput

CompassCatalogMutationApiUpdateComponentArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputUpdateCompassComponentInput

CompassCatalogMutationApiUpdateComponentDataManagerMetadataArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputUpdateCompassComponentDataManagerMetadataInput

CompassCatalogMutationApiUpdateComponentLinkArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputUpdateCompassComponentLinkInput

CompassCatalogMutationApiUpdateCustomFieldDefinitionArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCompassUpdateCustomFieldDefinitionInput

CompassCatalogMutationApiUpdateMetricDefinitionArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCompassUpdateMetricDefinitionInput

CompassCatalogMutationApiUpdateScorecardArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputUpdateCompassScorecardInput
scorecardIdString

CompassCatalogMutationApiUpdateScorecardCriteriasArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputUpdateCompassScorecardCriteriasInput
scorecardIdString

CompassCatalogMutationApiUpdateTeamCheckinArgs

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
inputCompassUpdateTeamCheckinInput

CompassCatalogQueryApi

Top level wrapper for Compass Query API

Property NameTypeDescription
__typenameLiteral
componentMaybe<CompassComponentResult>Retrieves a single component by its internal ID.
componentByExternalAliasMaybe<CompassComponentResult>Retrieves a single component by its external alias.
customFieldDefinitionsMaybe<CompassCustomFieldDefinitionsResult>Retrieves custom field definitions by component type. 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.
eventSourceMaybe<CompassEventSourceResult>Retrieve a single event source by its external ID and event type. 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.
fieldDefinitionsByComponentTypeMaybe<CompassFieldDefinitionsResult>Retrieves field definitions by component type.
metricDefinitionMaybe<CompassMetricDefinitionResult>Retrieves a single metric definition by its internal ID. 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.
metricDefinitionsMaybe<CompassMetricDefinitionsQueryResult>A collection of metric definitions on a Compass site. A metric definition provides details for a metric source. 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.
scorecardMaybe<CompassScorecardResult>Retrieves a scorecard by its unique identifier (ID).
scorecardsMaybe<CompassScorecardsQueryResult>Retrieves available scorecards.
searchComponentLabelsMaybe<CompassComponentLabelsQueryResult>Searches for all component labels within Compass. 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.
searchComponentsMaybe<CompassComponentQueryResult>Searches for Compass components.
starredComponentsMaybe<CompassStarredComponentQueryResult>Retrieve all starred components based on the user id.
teamCheckinsMaybe<Array<CompassTeamCheckin>>A collection of checkins posted by a team; sorted by most recent. 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.

CompassCatalogQueryApiComponentArgs

Top level wrapper for Compass Query API

Property NameTypeDescription
idString

CompassCatalogQueryApiComponentByExternalAliasArgs

Top level wrapper for Compass Query API

Property NameTypeDescription
cloudIdString
externalIDString
externalSourceInputMaybe<String>

CompassCatalogQueryApiCustomFieldDefinitionsArgs

Top level wrapper for Compass Query API

Property NameTypeDescription
queryCompassCustomFieldDefinitionsQuery

CompassCatalogQueryApiEventSourceArgs

Top level wrapper for Compass Query API

Property NameTypeDescription
cloudIdString
eventTypeCompassEventType
externalEventSourceIdString

CompassCatalogQueryApiFieldDefinitionsByComponentTypeArgs

Top level wrapper for Compass Query API

Property NameTypeDescription
cloudIdString
inputCompassComponentType

CompassCatalogQueryApiMetricDefinitionArgs

Top level wrapper for Compass Query API

Property NameTypeDescription
cloudIdString
metricDefinitionIdString

CompassCatalogQueryApiMetricDefinitionsArgs

Top level wrapper for Compass Query API

Property NameTypeDescription
queryCompassMetricDefinitionsQuery

CompassCatalogQueryApiScorecardArgs

Top level wrapper for Compass Query API

Property NameTypeDescription
idString

CompassCatalogQueryApiScorecardsArgs

Top level wrapper for Compass Query API

Property NameTypeDescription
cloudIdString
queryInputMaybe<CompassScorecardsQuery>

CompassCatalogQueryApiSearchComponentLabelsArgs

Top level wrapper for Compass Query API

Property NameTypeDescription
cloudIdString
queryInputMaybe<CompassSearchComponentLabelsQuery>

CompassCatalogQueryApiSearchComponentsArgs

Top level wrapper for Compass Query API

Property NameTypeDescription
cloudIdString
queryInputMaybe<CompassSearchComponentQuery>

CompassCatalogQueryApiStarredComponentsArgs

Top level wrapper for Compass Query API

Property NameTypeDescription
cloudIdString
queryInputMaybe<CompassStarredComponentQuery>

CompassCatalogQueryApiTeamCheckinsArgs

Top level wrapper for Compass Query API

Property NameTypeDescription
inputCompassTeamCheckinsInput

CompassChangeMetadata

Metadata about who created or updated the object and when.

Property NameTypeDescription
__typenameLiteral
createdAtMaybe<Any>The date and time when the object was created.
createdByMaybe<User>The user who created the object.
lastUserModificationAtMaybe<Any>The date and time when the object was last updated.
lastUserModificationByMaybe<User>The user who last updated the object.

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. 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.
applicableScorecardsMaybe<Array<CompassScorecard>>A collection of scorecards applicable to a component.
changeMetadataCompassChangeMetadataMetadata about who created the component and when.
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.
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. 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.
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.
relationshipsMaybe<CompassRelationshipConnectionResult>A collection of relationships between the component and other entities in Compass.
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.
typeCompassComponentTypeThe type of component.

CompassComponentEventsArgs

A component represents a software development artifact tracked in Compass.

Property NameTypeDescription
queryInputMaybe<CompassEventsQuery>

CompassComponentMetricSourcesArgs

A component represents a software development artifact tracked in Compass.

Property NameTypeDescription
queryInputMaybe<CompassComponentMetricSourcesQuery>

CompassComponentRelationshipsArgs

A component represents a software development artifact tracked in Compass.

Property NameTypeDescription
queryInputMaybe<CompassRelationshipQuery>

CompassComponentScorecardScoreArgs

A component represents a software development artifact tracked in Compass.

Property NameTypeDescription
queryInputMaybe<CompassComponentScorecardScoreQuery>

CompassComponentDataManager

An external integration that manages data for a particular component.

Property NameTypeDescription
__typenameLiteral
ecosystemAppIdStringThe unique identifier (ID) of the ecosystem app acting as a component data manager.
externalSourceURLMaybe<Any>An URL of the external source.
lastSyncEventMaybe<ComponentSyncEvent>Details about the last sync event to this component.

CompassComponentLabel

A label provides additional contextual information about a component.

Property NameTypeDescription
__typenameLiteral
nameMaybe<String>The name of the label.

CompassComponentLabelsQueryResult

CompassComponentMetricSourcesConnection

A connection that returns a paginated collection of metric sources.

Property NameTypeDescription
__typenameLiteral
edgesMaybe<Array<CompassMetricSourceEdge>>A list of edges which contain a metric source and a cursor.
nodesMaybe<Array<CompassMetricSource>>A list of metric sources.
pageInfoPageInfoPagination information such as the start and end cursor of this page, and whether there is a next and previous page.

CompassComponentMetricSourcesQuery

The query to get the metric sources of a component.

Property NameTypeDescription
afterInputMaybe<String>Returns results after the specified cursor.
firstInputMaybe<Number>The number of results to return in the query. The default is 10.

CompassComponentMetricSourcesQueryResult

CompassComponentQueryResult

CompassComponentResult

CompassComponentScorecardScoreQuery

Scorecard score on a component for a scorecard.

Property NameTypeDescription
scorecardIdStringThe unique identifier (ID) of the scorecard.

CompassCreateAlertEventInput

An alert event.

Property NameTypeDescription
alertPropertiesCompassAlertEventPropertiesInputAlert Properties
descriptionStringThe description of the event.
displayNameStringThe name of the event.
externalEventSourceIdStringThe ID of the external event source.
lastUpdatedAnyThe last time this event was updated.
updateSequenceNumberAnyA number specifying the order of the update to the event.
urlAnyThe URL of the event.

CompassCreateAnnouncementInput

Accepts input for creating a component announcement.

Property NameTypeDescription
componentIdStringThe ID of the component to create an announcement for.
descriptionInputMaybe<String>The description of the announcement.
targetDateAnyThe date on which the changes in the announcement will take effect.
titleStringThe title of the announcement.

CompassCreateAnnouncementPayload

The payload returned after creating a component announcement.

Property NameTypeDescription
__typenameLiteral
createdAnnouncementMaybe<CompassAnnouncement>The created announcement.
errorsMaybe<Array<MutationError>>A list of errors that occurred during the mutation.
successBooleanWhether the mutation was successful or not.

CompassCreateBuildEventInput

A build event.

Property NameTypeDescription
buildPropertiesCompassBuildEventPropertiesInputBuild Properties
descriptionStringThe description of the event.
displayNameStringThe name of the event.
externalEventSourceIdStringThe ID of the external event source.
lastUpdatedAnyThe last time this event was updated.
updateSequenceNumberAnyA number specifying the order of the update to the event.
urlAnyThe URL of the event.

CompassCreateCustomBooleanFieldDefinitionInput

Property NameTypeDescription
cloudIdStringThe cloud ID of the site to create a custom field definition for.
componentTypesArray<CompassComponentType>The component types the field applies to.
descriptionInputMaybe<String>The description of the field.
nameStringThe name of the field.

CompassCreateCustomEventInput

A custom event.

Property NameTypeDescription
customEventPropertiesCompassCustomEventPropertiesInputCustom Event Properties
descriptionStringThe description of the event.
displayNameStringThe name of the event.
externalEventSourceIdStringThe ID of the external event source.
lastUpdatedAnyThe last time this event was updated.
updateSequenceNumberAnyA number specifying the order of the update to the event.
urlAnyThe URL of the event.

CompassCreateCustomFieldDefinitionInput

CompassCreateCustomFieldDefinitionPayload

Property NameTypeDescription
__typenameLiteral
customFieldDefinitionMaybe<CompassCustomFieldDefinition>
errorsMaybe<Array<MutationError>>
successBoolean

CompassCreateCustomNumberFieldDefinitionInput

Property NameTypeDescription
cloudIdStringThe cloud ID of the site to create a custom field definition for.
componentTypesArray<CompassComponentType>The component types the field applies to.
descriptionInputMaybe<String>The description of the field.
nameStringThe name of the field.

CompassCreateCustomTextFieldDefinitionInput

Property NameTypeDescription
cloudIdStringThe cloud ID of the site to create a custom field definition for.
componentTypesArray<CompassComponentType>The component types the field applies to.
descriptionInputMaybe<String>The description of the field.
nameStringThe name of the field.

CompassCreateDeploymentEventInput

A deployment event.

Property NameTypeDescription
deploymentPropertiesCompassCreateDeploymentEventPropertiesInputDeployment Properties
descriptionStringThe description of the deployment event.
displayNameStringThe name of the deployment event.
externalEventSourceIdStringThe ID of the external event source.
lastUpdatedAnyThe last time this event was updated.
updateSequenceNumberAnyA number specifying the order of the update to the event.
urlAnyThe URL of the deployment event.

CompassCreateDeploymentEventPropertiesInput

The list of properties of the deployment event.

Property NameTypeDescription
environmentCompassDeploymentEventEnvironmentInputThe environment where the deployment event has occurred.
pipelineCompassDeploymentEventPipelineInputThe deployment event pipeline.
sequenceNumberAnyThe sequence number for the deployment.
stateCompassDeploymentEventStateThe state of the deployment.

CompassCreateEventInput

Property NameTypeDescription
cloudIdStringThe cloud ID of the site to create the event for.
eventCompassEventInput

CompassCreateEventsPayload

Property NameTypeDescription
__typenameLiteral
errorsMaybe<Array<MutationError>>A list of errors that occurred during the mutation.
successBooleanWhether the mutation was successful or not.

CompassCreateFlagEventInput

A flag event.

Property NameTypeDescription
descriptionStringThe description of the event.
displayNameStringThe name of the event.
externalEventSourceIdStringThe ID of the external event source.
flagPropertiesCompassCreateFlagEventPropertiesInputFlag Properties
lastUpdatedAnyThe last time this event was updated.
updateSequenceNumberAnyA number specifying the order of the update to the event.
urlAnyThe URL of the event.

CompassCreateFlagEventPropertiesInput

The list of properties of the flag event.

Property NameTypeDescription
idStringThe ID of the flag.
statusInputMaybe<String>Status of the flag

CompassCreateIncidentEventInput

An incident event.

Property NameTypeDescription
descriptionStringThe description of the event.
displayNameStringThe name of the event.
externalEventSourceIdStringThe ID of the external event source.
incidentPropertiesCompassCreateIncidentEventPropertiesInputIncident Properties
lastUpdatedAnyThe last time this event was updated.
updateSequenceNumberAnyA number specifying the order of the update to the event.
urlAnyThe URL of the event.

CompassCreateIncidentEventPropertiesInput

The list of properties of the incident event.

Property NameTypeDescription
idStringThe ID of the incident.
stateCompassIncidentEventStateThe state of the incident.

CompassCreateLifecycleEventInput

A lifecycle event.

Property NameTypeDescription
descriptionStringThe description of the event.
displayNameStringThe name of the event.
externalEventSourceIdStringThe ID of the external event source.
lastUpdatedAnyThe last time this event was updated.
lifecyclePropertiesCompassLifecycleEventInputPropertiesLifecycle Properties
updateSequenceNumberAnyA number specifying the order of the update to the event.
urlAnyThe URL of the event.

CompassCreateMetricDefinitionInput

The input for creating a metric definition.

Property NameTypeDescription
cloudIdStringThe cloud ID of the Compass site to create a metric definition on.
descriptionInputMaybe<String>The description of the metric definition.
formatInputMaybe<CompassMetricDefinitionFormatInput>The format option for applying to the display of metric values.
nameStringThe name of the metric definition.

CompassCreateMetricDefinitionPayload

The payload returned from creating a metric definition.

Property NameTypeDescription
__typenameLiteral
createdMetricDefinitionMaybe<CompassMetricDefinition>The created metric definition.
errorsMaybe<Array<MutationError>>A list of errors that occurred during the mutation.
successBooleanWhether the mutation was successful or not.

CompassCreateMetricSourceInput

The input to create a metric source.

Property NameTypeDescription
componentIdStringThe ID of the component to create a metric source on.
externalMetricSourceIdStringThe unique identifier (ID) of the metric source that is external to the Compass site, for example, a Bitbucket repository ID.
metricDefinitionIdStringThe ID of the metric definition which defines the metric source.
urlInputMaybe<String>The URL of the metric source.

CompassCreateMetricSourcePayload

The payload returned from creating a metric source.

Property NameTypeDescription
__typenameLiteral
createdMetricSourceMaybe<CompassMetricSource>The metric source that is created.
errorsMaybe<Array<MutationError>>A list of errors that occurred during the mutation.
successBooleanWhether the mutation was successful or not.

CompassCreateTeamCheckinActionInput

Accepts input for creating team checkin's action item.

Property NameTypeDescription
actionTextStringThe text of the team checkin action item.
completedInputMaybe<Boolean>Whether the action is completed or not.

CompassCreateTeamCheckinInput

Accepts input for creating a checkin.

Property NameTypeDescription
actionsInputMaybe<Array<CompassCreateTeamCheckinActionInput>>A list of action items to be created with the checkin.
cloudIdStringThe cloud ID of the site to update a checkin on.
moodNumberThe mood of the checkin.
response1InputMaybe<String>The response to the question 1 of the team checkin.
response2InputMaybe<String>The response to the question 2 of the team checkin.
response3InputMaybe<String>The response to the question 3 of the team checkin.
teamIdStringThe unique identifier (ID) of the team that did the checkin.

CompassCreateTeamCheckinPayload

The payload returned after creating a component announcement.

Property NameTypeDescription
__typenameLiteral
createdTeamCheckinMaybe<CompassTeamCheckin>Details of the created team checkin.
errorsMaybe<Array<MutationError>>A list of errors that occurred during the mutation.
successBooleanWhether the mutation was successful or not.

CompassCustomBooleanField

Property NameTypeDescription
__typenameLiteral
booleanValueMaybe<Boolean>The value of the field.
definitionMaybe<CompassCustomBooleanFieldDefinition>The definition of the field.

CompassCustomBooleanFieldDefinition

The schema of a custom boolean field.

Property NameTypeDescription
__typenameLiteral
componentTypesMaybe<Array<CompassComponentType>>The component types the field applies to.
descriptionMaybe<String>The description of the field.
idStringThe unique identifier (ID) of the field definition.
nameMaybe<String>The name of the field.

CompassCustomBooleanFieldInput

Property NameTypeDescription
booleanValueBooleanThe value of the field.
definitionIdStringThe ID of the field definition.

CompassCustomEvent

Property NameTypeDescription
__typenameLiteral
customEventPropertiesCompassCustomEventPropertiesCustom Event Properties
descriptionMaybe<String>The description of the event.
displayNameStringThe name of the event.
eventTypeCompassEventTypeThe type of the event.
lastUpdatedAnyThe last time this event was updated.
updateSequenceNumberAnyA number specifying the order of the update to the event.
urlMaybe<Any>The URL of the event.

CompassCustomEventProperties

################################################################################################################### COMPASS CUSTOM EVENT ###################################################################################################################

Property NameTypeDescription
__typenameLiteral
iconMaybe<CompassCustomEventIcon>The icon for the custom event.
idStringThe ID of the custom event.

CompassCustomEventPropertiesInput

The list of properties of the custom event.

Property NameTypeDescription
iconCompassCustomEventIconThe icon for the custom event.
idStringThe ID of the custom event.

CompassCustomField

A custom field represents data about a component.

Property NameTypeDescription
definitionMaybe<CompassCustomFieldDefinition>

CompassCustomFieldDefinition

The schema of a custom field.

Property NameTypeDescription
componentTypesMaybe<Array<CompassComponentType>>The component types the field applies to.
descriptionMaybe<String>The description of the field.
idStringThe unique identifier (ID) of the field definition.
nameMaybe<String>The name of the field.

CompassCustomFieldDefinitionEdge

Property NameTypeDescription
__typenameLiteral
cursorString
nodeMaybe<CompassCustomFieldDefinition>

CompassCustomFieldDefinitionsConnection

Property NameTypeDescription
__typenameLiteral
edgesMaybe<Array<CompassCustomFieldDefinitionEdge>>
nodesMaybe<Array<CompassCustomFieldDefinition>>
pageInfoPageInfo

CompassCustomFieldDefinitionsQuery

################################################################################################################### COMPASS CUSTOM FIELD DEFINITION API TYPES ###################################################################################################################

Property NameTypeDescription
cloudIdString
componentTypesInputMaybe<Array<CompassComponentType>>Optional filter to search for the field definitions attached to any of the specified component types. Returns all field definitions by default.

CompassCustomFieldDefinitionsResult

CompassCustomFieldInput

CompassCustomNumberField

Property NameTypeDescription
__typenameLiteral
definitionMaybe<CompassCustomNumberFieldDefinition>The definition of the field.
numberValueMaybe<Number>The value of the field.

CompassCustomNumberFieldDefinition

The schema of a custom number field.

Property NameTypeDescription
__typenameLiteral
componentTypesMaybe<Array<CompassComponentType>>The component types the field applies to.
descriptionMaybe<String>The description of the field.
idStringThe unique identifier (ID) of the field definition.
nameMaybe<String>The name of the field.

CompassCustomNumberFieldInput

Property NameTypeDescription
definitionIdStringThe ID of the field definition.
numberValueInputMaybe<Number>The value of the field.

CompassCustomTextField

Property NameTypeDescription
__typenameLiteral
definitionMaybe<CompassCustomTextFieldDefinition>The definition of the field.
textValueMaybe<String>The value of the field.

CompassCustomTextFieldDefinition

The schema of a custom text field.

Property NameTypeDescription
__typenameLiteral
componentTypesMaybe<Array<CompassComponentType>>The component types the field applies to.
descriptionMaybe<String>The description of the field.
idStringThe unique identifier (ID) of the field definition.
nameMaybe<String>The name of the field.

CompassCustomTextFieldInput

Property NameTypeDescription
definitionIdStringThe ID of the field definition.
textValueInputMaybe<String>The value of the field.

CompassDeleteAnnouncementInput

Accepts input for deleting a component announcement.

Property NameTypeDescription
cloudIdStringThe cloud ID of the site to delete an announcement from.
idStringThe ID of the announcement to delete.

CompassDeleteAnnouncementPayload

The payload returned after deleting a component announcement.

Property NameTypeDescription
__typenameLiteral
deletedAnnouncementIdMaybe<String>The ID of the announcement that was deleted.
errorsMaybe<Array<MutationError>>A list of errors that occurred during the mutation.
successBooleanWhether the mutation was successful or not.

CompassDeleteCustomFieldDefinitionInput

Property NameTypeDescription
idString

CompassDeleteCustomFieldDefinitionPayload

Property NameTypeDescription
__typenameLiteral
customFieldDefinitionIdMaybe<String>
errorsMaybe<Array<MutationError>>
successBoolean

CompassDeleteMetricDefinitionInput

The input to delete a metric definition.

Property NameTypeDescription
idStringThe ID of the metric definition to be deleted.

CompassDeleteMetricDefinitionPayload

The payload returned from updating a metric definition.

Property NameTypeDescription
__typenameLiteral
deletedMetricDefinitionIdMaybe<String>The ID of the deleted metric definition.
errorsMaybe<Array<MutationError>>A list of errors that occurred during the mutation.
successBooleanWhether the mutation was successful or not.

CompassDeleteMetricSourceInput

The input to delete a metric source.

Property NameTypeDescription
idStringThe ID of the metric source to be deleted.

CompassDeleteMetricSourcePayload

The payload returned from deleting a metric source.

Property NameTypeDescription
__typenameLiteral
deletedMetricSourceIdMaybe<String>The ID of the metric source that is deleted.
errorsMaybe<Array<MutationError>>A list of errors that occurred during the mutation.
successBooleanWhether the mutation was successful or not.

CompassDeleteTeamCheckinActionInput

Accepts input for deleting a team checkin.

Property NameTypeDescription
idStringThe ID of the team checkin item to delete.

CompassDeleteTeamCheckinInput

Accepts input for deleting a team checkin.

Property NameTypeDescription
cloudIdStringThe cloud ID of the site to update a checkin on.
idStringThe ID of the team checkin to delete.

CompassDeleteTeamCheckinPayload

The payload returned after deleting a team checkin.

Property NameTypeDescription
__typenameLiteral
deletedTeamCheckinIdMaybe<String>ID of the checkin that was deleted.
errorsMaybe<Array<MutationError>>A list of errors that occurred during the mutation.
successBooleanWhether the mutation was successful or not.

CompassDeploymentEvent

Property NameTypeDescription
__typenameLiteral
deploymentPropertiesCompassDeploymentEventPropertiesDeployment Properties
deploymentSequenceNumberMaybe<Any>The sequence number for the deployment.
descriptionMaybe<String>The description of the deployment event.
displayNameStringThe name of the deployment event.
environmentMaybe<CompassDeploymentEventEnvironment>The environment where the deployment event has occurred.
eventTypeCompassEventTypeThe type of the event.
lastUpdatedAnyThe last time this event was updated.
pipelineMaybe<CompassDeploymentEventPipeline>The deployment event pipeline.
stateMaybe<CompassDeploymentEventState>The state of the deployment.
updateSequenceNumberAnyA number specifying the order of the update to the event.
urlMaybe<Any>The URL of the deployment event.

CompassDeploymentEventEnvironment

Property NameTypeDescription
__typenameLiteral
categoryMaybe<CompassDeploymentEventEnvironmentCategory>The type of environment where the deployment event occurred.
displayNameMaybe<String>The display name of the environment where the deployment event occurred.
environmentIdMaybe<String>The ID of the environment where the deployment event occurred.

CompassDeploymentEventEnvironmentInput

The environment where the deployment event has occurred.

Property NameTypeDescription
categoryCompassDeploymentEventEnvironmentCategoryThe type of environment where the deployment event occurred.
displayNameStringThe display name of the environment where the deployment event occurred.
environmentIdStringThe ID of the environment where the deployment event occurred.

CompassDeploymentEventPipeline

Property NameTypeDescription
__typenameLiteral
displayNameMaybe<String>The name of the deployment event pipeline.
pipelineIdMaybe<String>The ID of the deployment event pipeline.
urlMaybe<String>The URL of the deployment event pipeline.

CompassDeploymentEventPipelineInput

The deployment event pipeline.

Property NameTypeDescription
displayNameStringThe name of the deployment event pipeline.
pipelineIdStringThe ID of the deployment event pipeline.
urlStringThe URL of the deployment event pipeline.

CompassDeploymentEventProperties

Property NameTypeDescription
__typenameLiteral
environmentMaybe<CompassDeploymentEventEnvironment>The environment where the deployment event has occurred.
pipelineMaybe<CompassDeploymentEventPipeline>The deployment event pipeline.
sequenceNumberMaybe<Any>The sequence number for the deployment.
stateMaybe<CompassDeploymentEventState>The state of the deployment.

CompassEnumField

Property NameTypeDescription
__typenameLiteral
definitionMaybe<CompassFieldDefinition>The definition of the field.
valueMaybe<Array<String>>The value of the field.

CompassEnumFieldDefinitionOptions

Property NameTypeDescription
__typenameLiteral
defaultMaybe<Array<String>>The default option for field definition. If null, the field is not required.
valuesMaybe<Array<String>>Possible values of the field definition.

CompassEnumFieldValueInput

Property NameTypeDescription
valueInputMaybe<Array<String>>

CompassEvent

Property NameTypeDescription
descriptionMaybe<String>The description of the event.
displayNameStringThe name of the event.
eventTypeCompassEventTypeThe type of the event.
lastUpdatedAnyThe last time this event was updated.
updateSequenceNumberAnyA number specifying the order of the update to the event.
urlMaybe<Any>The URL of the event.

CompassEventConnection

Property NameTypeDescription
__typenameLiteral
edgesMaybe<Array<Maybe<CompassEventEdge>>>
nodesMaybe<Array<CompassEvent>>
pageInfoPageInfo

CompassEventEdge

Property NameTypeDescription
__typenameLiteral
cursorString
nodeMaybe<CompassEvent>

CompassEventInput

The type of event. One and only one of the fields in this input type must be provided.

CompassEventSourceResult

CompassEventTimeParameters

Property NameTypeDescription
endAtInputMaybe<Any>The time to end querying for event data.
startFromInputMaybe<Any>The time to begin querying for event data.

CompassEventsInEventSourceQuery

Property NameTypeDescription
afterInputMaybe<String>Returns the events after the specified cursor position.
firstInputMaybe<Number>The first N number of events to return in the query.
timeParametersInputMaybe<CompassEventTimeParameters>Returns the events after that match the CompassEventTimeParameters.

CompassEventsQuery

Property NameTypeDescription
afterInputMaybe<String>Returns the events after the specified cursor position.
eventTypesInputMaybe<Array<CompassEventType>>The list of event types.
firstInputMaybe<Number>The first N number of events to return in the query.
timeParametersInputMaybe<CompassEventTimeParameters>Returns the events after that match the CompassEventTimeParameters.

CompassEventsQueryResult

CompassExternalAlias

An alias of the component in an external system.

Property NameTypeDescription
__typenameLiteral
externalAliasIdStringThe ID of the component in an external system.
externalSourceMaybe<String>The external system hosting the component.

CompassExternalAliasInput

Property NameTypeDescription
externalIdStringThe ID of the component in the external source
externalSourceInputMaybe<String>The external system hosting the component

CompassField

A field represents data about a component.

Property NameTypeDescription
definitionMaybe<CompassFieldDefinition>The definition of the field.

CompassFieldDefinition

The schema of a field.

Property NameTypeDescription
__typenameLiteral
descriptionStringThe description of the field.
idStringThe unique identifier (ID) of the field definition.
nameStringThe name of the field.
optionsCompassFieldDefinitionOptionsThe options for the field definition.
typeCompassFieldTypeThe type of field.

CompassFieldDefinitionOptions

CompassFieldDefinitions

Property NameTypeDescription
__typenameLiteral
definitionsArray<CompassFieldDefinition>

CompassFieldDefinitionsResult

CompassFieldValueInput

Property NameTypeDescription
enumInputMaybe<CompassEnumFieldValueInput>

CompassFlagEvent

Property NameTypeDescription
__typenameLiteral
descriptionMaybe<String>The description of the event.
displayNameStringThe name of the event.
eventTypeCompassEventTypeThe type of the event.
flagPropertiesCompassFlagEventPropertiesFlag Properties
lastUpdatedAnyThe last time this event was updated.
updateSequenceNumberAnyA number specifying the order of the update to the event.
urlMaybe<Any>The URL of the event.

CompassFlagEventProperties

################################################################################################################### CompassHasDescriptionScorecardCriteria The configuration for a scorecard criterion representing the presence of a description.

Property NameTypeDescription
__typenameLiteral
idString
scorecardCriteriaScoreMaybe<CompassScorecardCriteriaScore>Returns the calculated score for a given component
weightNumber

CompassHasDescriptionScorecardCriteriaScorecardCriteriaScoreArgs

The configuration for a scorecard criterion representing the presence of a description.

Property NameTypeDescription
queryInputMaybe<CompassScorecardCriteriaScoreQuery>

CompassHasFieldScorecardCriteria

The configuration for a scorecard criterion representing the presence of a field, for example, 'Has Tier'.

Property NameTypeDescription
__typenameLiteral
fieldDefinitionCompassFieldDefinitionThe target of a relationship, for example, 'Owner' if 'Has Owner'.
idStringThe ID of the scorecard criterion.
scorecardCriteriaScoreMaybe<CompassScorecardCriteriaScore>Returns the calculated score for a component.
weightNumberThe weight that will be used in determining the aggregate score.

CompassHasFieldScorecardCriteriaScorecardCriteriaScoreArgs

The configuration for a scorecard criterion representing the presence of a field, for example, 'Has Tier'.

Property NameTypeDescription
queryInputMaybe<CompassScorecardCriteriaScoreQuery>

CompassHasLinkScorecardCriteria

The configuration for a scorecard criterion representing the presence of a link, for example, 'Has Repository', or 'Has Documentation'.

Property NameTypeDescription
__typenameLiteral
idStringThe ID of the scorecard criterion.
linkTypeCompassLinkTypeThe type of link, for example 'Repository' if 'Has Repository'.
scorecardCriteriaScoreMaybe<CompassScorecardCriteriaScore>Returns the calculated score for a component.
weightNumberThe weight that will be used in determining the aggregate score.

CompassHasLinkScorecardCriteriaScorecardCriteriaScoreArgs

The configuration for a scorecard criterion representing the presence of a link, for example, 'Has Repository', or 'Has Documentation'.

Property NameTypeDescription
queryInputMaybe<CompassScorecardCriteriaScoreQuery>

CompassHasMetricValueScorecardCriteria

The configuration for a scorecard criterion checking the value of a specified metric name.

Property NameTypeDescription
__typenameLiteral
comparatorCompassCriteriaNumberComparatorOptionsThe comparison operation to be performed between the metric and comparator value.
comparatorValueNumberThe threshold value that the metric is compared to.
idStringThe ID of the scorecard criterion.
metricDefinitionMaybe<CompassMetricDefinition>Returns the metric definition this criteria uses.
metricDefinitionIdStringThe ID of the component metric to check the value of.
scorecardCriteriaScoreMaybe<CompassScorecardCriteriaScore>Returns the calculated score for a component.
weightNumberThe weight that will be used in determining the aggregate score.

CompassHasMetricValueScorecardCriteriaScorecardCriteriaScoreArgs

The configuration for a scorecard criterion checking the value of a specified metric name.

Property NameTypeDescription
queryInputMaybe<CompassScorecardCriteriaScoreQuery>

CompassHasOwnerScorecardCriteria

Configuration for a scorecard criteria representing the presence of an owner

Property NameTypeDescription
__typenameLiteral
idStringThe ID of the scorecard criterion.
scorecardCriteriaScoreMaybe<CompassScorecardCriteriaScore>Returns the calculated score for a component.
weightNumberThe weight that will be used in determining the aggregate score.

CompassHasOwnerScorecardCriteriaScorecardCriteriaScoreArgs

Configuration for a scorecard criteria representing the presence of an owner

Property NameTypeDescription
queryInputMaybe<CompassScorecardCriteriaScoreQuery>

CompassIncidentEvent

Property NameTypeDescription
__typenameLiteral
descriptionMaybe<String>The description of the event.
displayNameStringThe name of the event.
eventTypeCompassEventTypeThe type of the event.
incidentPropertiesCompassIncidentEventPropertiesIncident Properties
lastUpdatedAnyThe last time this event was updated.
updateSequenceNumberAnyA number specifying the order of the update to the event.
urlMaybe<Any>The URL of the event.

CompassIncidentEventProperties

################################################################################################################### COMPASS INCIDENT EVENT ###################################################################################################################

Property NameTypeDescription
__typenameLiteral
idStringThe ID of the incident.
stateMaybe<CompassIncidentEventState>The state of the incident.

CompassInsertMetricValueByExternalIdInput

The input to insert a metric value by metricDefinitionId and externalMetricSourceId

Property NameTypeDescription
cloudIdStringThe cloud ID of the site to insert a metric value for.
externalMetricSourceIdStringThe unique identifier (ID) of the metric source that is external to the Compass site, for example, a Bitbucket repository ID.
metricDefinitionIdStringThe unique identifier (ID) of the metric definition for which the value applies.
valueCompassMetricValueInputThe metric value to be inserted.

CompassInsertMetricValueByExternalIdPayload

The payload returned from inserting a metric value by external ID.

Property NameTypeDescription
__typenameLiteral
errorsMaybe<Array<MutationError>>A list of errors that occurred during the mutation.
successBooleanWhether the mutation was successful or not.

CompassInsertMetricValueInput

The input to insert a metric value.

Property NameTypeDescription
metricSourceIdStringThe ID of the metric source to insert the value into.
valueCompassMetricValueInputThe metric value to insert.

CompassInsertMetricValuePayload

The payload returned from inserting a metric value.

Property NameTypeDescription
__typenameLiteral
errorsMaybe<Array<MutationError>>A list of errors that occurred during the mutation.
metricSourceMaybe<CompassMetricSource>The metric source that the value was inserted into.
successBooleanWhether the mutation was successful or not.

CompassLifecycleEvent

Property NameTypeDescription
__typenameLiteral
descriptionMaybe<String>The description of the event.
displayNameStringThe name of the event.
eventTypeCompassEventTypeThe type of the event.
lastUpdatedAnyThe last time this event was updated.
lifecyclePropertiesCompassLifecycleEventPropertiesThe lifecycle properties.
updateSequenceNumberAnyA number specifying the order of the update to the event.
urlMaybe<Any>The URL of the event.

CompassLifecycleEventInputProperties

The list of properties of the lifecycle event.

Property NameTypeDescription
idStringThe ID of the lifecycle.
stageCompassLifecycleEventStageThe stage of the lifecycle event.

CompassLifecycleEventProperties

################################################################################################################### COMPASS LIFECYCLE EVENT ###################################################################################################################

Property NameTypeDescription
__typenameLiteral
idStringThe ID of the lifecycle.
stageMaybe<CompassLifecycleEventStage>The stage of the lifecycle event.

A link to an entity or resource on the internet.

Property NameTypeDescription
__typenameLiteral
idStringThe unique identifier (ID) of the link.
nameMaybe<String>An user-provided name of the link.
typeCompassLinkTypeThe type of link.
urlAnyAn URL to the entity or resource on the internet.

CompassMetricDefinition

A metric definition defines a metric across multiple components.

Property NameTypeDescription
__typenameLiteral
descriptionMaybe<String>The description of the metric definition.
formatMaybe<CompassMetricDefinitionFormat>The format option for applying to the display of metric values.
idStringThe unique identifier (ID) of the metric definition.
metricSourcesMaybe<CompassMetricSourcesQueryResult>A collection of metrics which contain values that provide numerical data.
nameMaybe<String>The name of the metric definition.
typeCompassMetricDefinitionTypeThe type of the metric definition based on where the definition originated

CompassMetricDefinitionMetricSourcesArgs

A metric definition defines a metric across multiple components.

Property NameTypeDescription
queryInputMaybe<CompassMetricSourcesQuery>

CompassMetricDefinitionEdge

An edge that contains a metric definition and a cursor.

Property NameTypeDescription
__typenameLiteral
cursorStringThe cursor of the metric definition.
nodeMaybe<CompassMetricDefinition>The metric definition.

CompassMetricDefinitionFormat

CompassMetricDefinitionFormatInput

Property NameTypeDescription
suffixInputMaybe<CompassMetricDefinitionFormatSuffixInput>A plain-text suffix appended to the metric value when displayed, for example, 'MB/s'.

CompassMetricDefinitionFormatSuffix

The format option to append a plain-text suffix to metric values.

Property NameTypeDescription
__typenameLiteral
suffixMaybe<String>A plain-text suffix appended to the metric value when displayed, for example, 'MB/s'.

CompassMetricDefinitionFormatSuffixInput

The format option to append a plain-text suffix to metric values.

Property NameTypeDescription
suffixStringA plain-text suffix appended to the metric value when displayed, for example, 'MB/s'.

CompassMetricDefinitionResult

CompassMetricDefinitionsConnection

A connection that returns a paginated collection of metric definitions.

Property NameTypeDescription
__typenameLiteral
edgesMaybe<Array<CompassMetricDefinitionEdge>>A list of edges which contain a metric definition and a cursor.
nodesMaybe<Array<CompassMetricDefinition>>A list of metric definitions.
pageInfoPageInfoPagination information such as the start and end cursor of this page, and whether there is a next and previous page.

CompassMetricDefinitionsQuery

The query to get the metric definitions on a Compass site.

Property NameTypeDescription
afterInputMaybe<String>Returns results after the specified cursor.
cloudIdStringThe cloud ID of the site to query for metric definitions on.
firstInputMaybe<Number>The number of results to return in the query. The default is 10.

CompassMetricDefinitionsQueryResult

CompassMetricSource

A metric source contains values that provide numerical data about the component.

Property NameTypeDescription
__typenameLiteral
componentMaybe<CompassComponent>Compass component associated with this metric source.
externalMetricSourceIdMaybe<String>The unique identifier (ID) of the metric source that is external to the Compass site, for example, a Bitbucket repository ID.
idStringThe unique identifier (ID) of the metric source on the Compass site.
metricDefinitionMaybe<CompassMetricDefinition>The metric definition that defines the metric source.
urlMaybe<String>The URL of the metric source.
valuesMaybe<CompassMetricSourceValuesQueryResult>A collection of values which store historical data points about the component.

CompassMetricSourceValuesArgs

A metric source contains values that provide numerical data about the component.

Property NameTypeDescription
queryInputMaybe<CompassMetricSourceValuesQuery>

CompassMetricSourceEdge

An edge that contains a metric source and a cursor.

Property NameTypeDescription
__typenameLiteral
cursorStringThe cursor of the metric source.
nodeMaybe<CompassMetricSource>The metric source.

CompassMetricSourceValuesConnection

A connection that returns a paginated collection of metric values.

Property NameTypeDescription
__typenameLiteral
edgesMaybe<Array<CompassMetricValueEdge>>A list of edges which contain a metric values and a cursor.
nodesMaybe<Array<CompassMetricValue>>A list of metric values.
pageInfoPageInfoPagination information such as the start and end cursor of this page, and whether there is a next and previous page.

CompassMetricSourceValuesQuery

The query to get the metric values from a component's metric source.

Property NameTypeDescription
afterInputMaybe<String>Returns the values after the specified cursor position.
firstInputMaybe<Number>The number of results to return in the query. The default is 10.

CompassMetricSourceValuesQueryResult

CompassMetricSourcesConnection

Property NameTypeDescription
__typenameLiteral
edgesMaybe<Array<CompassMetricSourceEdge>>
nodesMaybe<Array<CompassMetricSource>>
pageInfoPageInfo

CompassMetricSourcesQuery

Property NameTypeDescription
afterInputMaybe<String>
firstInputMaybe<Number>

CompassMetricSourcesQueryResult

CompassMetricValue

A metric value stores the numerical data relating to the component.

Property NameTypeDescription
__typenameLiteral
timestampMaybe<Any>The time the metric value was collected.
valueMaybe<Number>The value of the metric.

CompassMetricValueEdge

An edge that contains a metric value and a cursor.

Property NameTypeDescription
__typenameLiteral
cursorStringThe cursor of the metric value.
nodeMaybe<CompassMetricValue>The metric value.

CompassMetricValueInput

A metric value to be inserted.

Property NameTypeDescription
timestampAnyThe time the metric value was collected.
valueNumberThe value of the metric.

CompassQueryFieldFilter

Field Filters.

Property NameTypeDescription
filterInputMaybe<CompassQueryFilter>
nameString

CompassQueryFilter

Property NameTypeDescription
eqInputMaybe<String>
gtInputMaybe<String>
inInputMaybe<Array<InputMaybe<String>>>
ltInputMaybe<String>
neqInputMaybe<String>

CompassQuerySort

Property NameTypeDescription
nameInputMaybe<String>
orderInputMaybe<CompassQuerySortOrder>name of field to sort results by

CompassRelationship

A relationship between two components.

Property NameTypeDescription
__typenameLiteral
changeMetadataMaybe<CompassChangeMetadata>
endNodeMaybe<CompassComponent>The ending node of the relationship.
startNodeMaybe<CompassComponent>The starting node of the relationship.
typeCompassRelationshipTypeThe type of relationship.

CompassRelationshipConnection

Property NameTypeDescription
__typenameLiteral
edgesMaybe<Array<CompassRelationshipEdge>>
nodesMaybe<Array<CompassRelationship>>
pageInfoPageInfo

CompassRelationshipConnectionResult

CompassRelationshipEdge

Property NameTypeDescription
__typenameLiteral
cursorString
nodeMaybe<CompassRelationship>

CompassRelationshipQuery

Accepts input for finding component relationships.

Property NameTypeDescription
afterInputMaybe<String>The relationships to be returned after the specified cursor position.
directionCompassRelationshipDirectionThe direction of relationships to be searched for.
filtersInputMaybe<CompassRelationshipQueryFilters>The filters for the relationships to be searched for.
firstInputMaybe<Number>The number of relationships to return in the query.

CompassRelationshipQueryFilters

Property NameTypeDescription
typesInputMaybe<Array<CompassRelationshipType>>OR'd set of relationship types.

CompassScorecard

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

Property NameTypeDescription
__typenameLiteral
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.
componentTypeCompassComponentTypeThe type of component to which this scorecard is restricted.
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.

CompassScorecardAppliedToComponentsArgs

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

Property NameTypeDescription
queryInputMaybe<CompassScorecardAppliedToComponentsQuery>

CompassScorecardScorecardScoreArgs

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

Property NameTypeDescription
queryInputMaybe<CompassScorecardScoreQuery>

CompassScorecardAppliedToComponentsConnection

Property NameTypeDescription
__typenameLiteral
edgesMaybe<Array<CompassScorecardAppliedToComponentsEdge>>
nodesMaybe<Array<CompassComponent>>
pageInfoPageInfo

CompassScorecardAppliedToComponentsEdge

Property NameTypeDescription
__typenameLiteral
cursorString
nodeMaybe<CompassComponent>

CompassScorecardAppliedToComponentsQuery

Accepts input to find components a scorecard is applied to and their scores

Property NameTypeDescription
afterInputMaybe<String>Returns the components after the specified cursor position.
filterInputMaybe<CompassScorecardAppliedToComponentsQueryFilter>Returns only components whose attributes match those in the filters specified
firstInputMaybe<Number>The first N number of components to return in the query.

CompassScorecardAppliedToComponentsQueryFilter

CompassScorecardAppliedToComponentsQueryResult

CompassScorecardAppliedToComponentsThresholdFilter

Property NameTypeDescription
ltNumber

CompassScorecardConnection

Property NameTypeDescription
__typenameLiteral
edgesMaybe<Array<CompassScorecardEdge>>
nodesMaybe<Array<CompassScorecard>>
pageInfoPageInfo

CompassScorecardCriteria

The configuration for a scorecard criterion that can be shared across components.

Property NameTypeDescription
idStringThe ID of the scorecard criterion.
scorecardCriteriaScoreMaybe<CompassScorecardCriteriaScore>Returns the calculated score for a component.
weightNumberThe weight that will be used in determining the aggregate score.

CompassScorecardCriteriaScorecardCriteriaScoreArgs

The configuration for a scorecard criterion that can be shared across components.

Property NameTypeDescription
queryInputMaybe<CompassScorecardCriteriaScoreQuery>

CompassScorecardCriteriaScore

Contains the calculated score for each scorecard criteria that is associated with a specific component.

Property NameTypeDescription
__typenameLiteral
maxScoreNumberThe maximum score value for the criterion. The value is used in calculating the aggregate score as a percentage.
scoreNumberThe calculated score value for the criterion.

CompassScorecardCriteriaScoreQuery

Property NameTypeDescription
componentIdStringThe unique identifier (ID) of the component.

CompassScorecardEdge

Property NameTypeDescription
__typenameLiteral
cursorString
nodeMaybe<CompassScorecard>

CompassScorecardResult

CompassScorecardScore

Contains the calculated score for a component. Each component has one calculated score per scorecard.

Property NameTypeDescription
__typenameLiteral
criteriaScoresMaybe<Array<CompassScorecardCriteriaScore>>Returns the scores for individual criterion.
maxTotalScoreNumberThe maximum possible total score value.
totalScoreNumberThe total calculated score value.

CompassScorecardScoreQuery