CompassApi
CompassRequests
api
compass-api
compound-types
graphql-types

Rate this page:

@atlassian/forge-graphql / graphql-types

Module: graphql-types

Type aliases

AddCompassComponentLabelsInput

Ƭ AddCompassComponentLabelsInput: Object

Accepts input for adding labels to a component.

Type declaration

NameTypeDescription
componentIdScalars"ID"The ID of the component to add the labels to.
labelNamesScalars"String"The collection of labels to add to the component.

Defined in

graphql-types.ts:316


AddCompassComponentLabelsPayload

Ƭ AddCompassComponentLabelsPayload: Payload & { __typename?: "AddCompassComponentLabelsPayload" ; addedLabels?: Maybe<CompassComponentLabel[]> ; componentDetails?: Maybe<CompassComponent> ; errors?: Maybe<MutationError[]> ; success: Scalars"Boolean" }

The payload returned after adding labels to a component.

Defined in

graphql-types.ts:324


ApplyCompassScorecardToComponentPayload

Ƭ ApplyCompassScorecardToComponentPayload: Payload & { __typename?: "ApplyCompassScorecardToComponentPayload" ; componentDetails?: Maybe<CompassComponent> ; errors?: Maybe<MutationError[]> ; success: Scalars"Boolean" }

The payload returned from applying a scorecard to a component.

Defined in

graphql-types.ts:1178


AttachCompassComponentDataManagerInput

Ƭ AttachCompassComponentDataManagerInput: Object

Accepts input to attach a data manager to a component.

Type declaration

NameTypeDescription
componentIdScalars"ID"The ID of the component to attach a data manager to.
externalSourceURL?InputMaybe<Scalars"URL">An URL of the external source of the component's data.

Defined in

graphql-types.ts:1286


AttachCompassComponentDataManagerPayload

Ƭ AttachCompassComponentDataManagerPayload: Payload & { __typename?: "AttachCompassComponentDataManagerPayload" ; componentDetails?: Maybe<CompassComponent> ; errors?: Maybe<MutationError[]> ; success: Scalars"Boolean" }

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

Defined in

graphql-types.ts:1294


AttachEventSourceInput

Ƭ AttachEventSourceInput: Object

Type declaration

NameTypeDescription
componentIdScalars"ID"The ID of the component to attach the event source to.
eventSourceIdScalars"ID"The ID of the event source.

Defined in

graphql-types.ts:1312


AttachEventSourcePayload

Ƭ AttachEventSourcePayload: Payload & { __typename?: "AttachEventSourcePayload" ; errors?: Maybe<MutationError[]> ; success: Scalars"Boolean" }

Defined in

graphql-types.ts:1319


CompassAcknowledgeAnnouncementInput

Ƭ CompassAcknowledgeAnnouncementInput: Object

Accepts input for acknowledging an announcement.

Type declaration

NameTypeDescription
announcementIdScalars"ID"The ID of the announcement being acknowledged.
componentIdScalars"ID"The ID of the component that is acknowledging the announcement.

Defined in

graphql-types.ts:2226


CompassAcknowledgeAnnouncementPayload

Ƭ CompassAcknowledgeAnnouncementPayload: Payload & { __typename?: "CompassAcknowledgeAnnouncementPayload" ; acknowledgement?: Maybe<CompassAnnouncementAcknowledgement> ; errors?: Maybe<MutationError[]> ; success: Scalars"Boolean" }

The payload returned after acknowledging an announcement.

Defined in

graphql-types.ts:2234


CompassAnnouncement

Ƭ CompassAnnouncement: Object

An announcement communicates news or updates relating to a component.

Type declaration

NameTypeDescription
__typename?"CompassAnnouncement"-
acknowledgements?Maybe<CompassAnnouncementAcknowledgement[]>The list of acknowledgements that are required for this announcement.
component?Maybe<CompassComponent>The component that posted the announcement. ### OAuth Scopes The following scopes will need to be present on OAuth requests to get data from this field * read:component:compass
description?Maybe<Scalars"String">The description of the announcement.
idScalars"ID"The ID of the announcement.
targetDate?Maybe<Scalars"DateTime">The date on which the updates in the announcement will take effect.
title?Maybe<Scalars"String">The title of the announcement.

Defined in

graphql-types.ts:2245


CompassAnnouncementAcknowledgement

Ƭ CompassAnnouncementAcknowledgement: Object

Tracks whether or not a component has acknowledged an announcement.

Type declaration

NameTypeDescription
__typename?"CompassAnnouncementAcknowledgement"-
component?Maybe<CompassComponent>The component that needs to acknowledge. ### OAuth Scopes The following scopes will need to be present on OAuth requests to get data from this field * read:component:compass
hasAcknowledged?Maybe<Scalars"Boolean">Whether the component has acknowledged the announcement or not.

Defined in

graphql-types.ts:2270


CompassCatalogMutationApi

Ƭ CompassCatalogMutationApi: Object

The top level wrapper for the Compass Mutations API.

Type declaration

NameTypeDescription
__typename?"CompassCatalogMutationApi"-
acknowledgeAnnouncement?Maybe<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. ### Beta Field This field is currently in a beta phase and may change without notice. To use this field you must set a X-ExperimentalApi: compass-prototype HTTP header. Use of this header indicates that they are opting into the experimental preview of this field. If you do not set this header then request will be rejected outright. Once the field moves out of the beta phase, then the header will no longer be required or checked. ### OAuth Scopes The following scopes will need to be present on OAuth requests to get data from this field * write:component:compass
addComponentLabels?Maybe<AddCompassComponentLabelsPayload>Adds a collection of labels to a component. ### OAuth Scopes The following scopes will need to be present on OAuth requests to get data from this field * write:component:compass
applyScorecardToComponent?Maybe<ApplyCompassScorecardToComponentPayload>Applies a scorecard to a component. ### OAuth Scopes The following scopes will need to be present on OAuth requests to get data from this field * write:component:compass
attachComponentDataManager?Maybe<AttachCompassComponentDataManagerPayload>Attach a data manager to a component. ### OAuth Scopes The following scopes will need to be present on OAuth requests to get data from this field * write:component:compass
attachEventSource?Maybe<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. ### Beta Field This field is currently in a beta phase and may change without notice. To use this field you must set a X-ExperimentalApi: compass-prototype HTTP header. Use of this header indicates that they are opting into the experimental preview of this field. If you do not set this header then request will be rejected outright. Once the field moves out of the beta phase, then the header will no longer be required or checked. ### OAuth Scopes The following scopes will need to be present on OAuth requests to get data from this field * write:component:compass
createAnnouncement?Maybe<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. ### Beta Field This field is currently in a beta phase and may change without notice. To use this field you must set a X-ExperimentalApi: compass-prototype HTTP header. Use of this header indicates that they are opting into the experimental preview of this field. If you do not set this header then request will be rejected outright. Once the field moves out of the beta phase, then the header will no longer be required or checked. ### OAuth Scopes The following scopes will need to be present on OAuth requests to get data from this field * write:component:compass
createComponent?Maybe<CreateCompassComponentPayload>Creates a new component. ### OAuth Scopes The following scopes will need to be present on OAuth requests to get data from this field * write:component:compass
createComponentExternalAlias?Maybe<CreateCompassComponentExternalAliasPayload>Creates an external alias for a component. ### OAuth Scopes The following scopes will need to be present on OAuth requests to get data from this field * write:component:compass
createComponentLink?Maybe<CreateCompassComponentLinkPayload>Creates a link for a component. ### OAuth Scopes The following scopes will need to be present on OAuth requests to get data from this field * write:component:compass
createDeploymentEvent?Maybe<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. ### Beta Field This field is currently in a beta phase and may change without notice. To use this field you must set a X-ExperimentalApi: compass-prototype HTTP header. Use of this header indicates that they are opting into the experimental preview of this field. If you do not set this header then request will be rejected outright. Once the field moves out of the beta phase, then the header will no longer be required or checked. ### OAuth Scopes The following scopes will need to be present on OAuth requests to get data from this field * write:event:compass
createEventSource?Maybe<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. ### Beta Field This field is currently in a beta phase and may change without notice. To use this field you must set a X-ExperimentalApi: compass-prototype HTTP header. Use of this header indicates that they are opting into the experimental preview of this field. If you do not set this header then request will be rejected outright. Once the field moves out of the beta phase, then the header will no longer be required or checked.
createMetricDefinition?Maybe<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. ### Beta Field This field is currently in a beta phase and may change without notice. To use this field you must set a X-ExperimentalApi: compass-prototype HTTP header. Use of this header indicates that they are opting into the experimental preview of this field. If you do not set this header then request will be rejected outright. Once the field moves out of the beta phase, then the header will no longer be required or checked.
createMetricSource?Maybe<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. ### Beta Field This field is currently in a beta phase and may change without notice. To use this field you must set a X-ExperimentalApi: compass-prototype HTTP header. Use of this header indicates that they are opting into the experimental preview of this field. If you do not set this header then request will be rejected outright. Once the field moves out of the beta phase, then the header will no longer be required or checked.
createRelationship?Maybe<CreateCompassRelationshipPayload>Creates a new relationship between two components. ### OAuth Scopes The following scopes will need to be present on OAuth requests to get data from this field * write:component:compass
createScorecard?Maybe<CreateCompassScorecardPayload>Creates a scorecard. ### OAuth Scopes The following scopes will need to be present on OAuth requests to get data from this field * write:scorecard:compass
createScorecardCriterias?Maybe<CreateCompassScorecardCriteriasPayload>Adds criteria to a scorecard. ### OAuth Scopes The following scopes will need to be present on OAuth requests to get data from this field * write:scorecard:compass
createStarredComponent?Maybe<CreateCompassStarredComponentPayload>Creates a starred relationship between a user and a component. ### OAuth Scopes The following scopes will need to be present on OAuth requests to get data from this field * write:component:compass
createTeamCheckin?Maybe<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. ### Beta Field This field is currently in a beta phase and may change without notice. To use this field you must set a X-ExperimentalApi: compass-prototype HTTP header. Use of this header indicates that they are opting into the experimental preview of this field. If you do not set this header then request will be rejected outright. Once the field moves out of the beta phase, then the header will no longer be required or checked.
deleteAnnouncement?Maybe<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. ### Beta Field This field is currently in a beta phase and may change without notice. To use this field you must set a X-ExperimentalApi: compass-prototype HTTP header. Use of this header indicates that they are opting into the experimental preview of this field. If you do not set this header then request will be rejected outright. Once the field moves out of the beta phase, then the header will no longer be required or checked. ### OAuth Scopes The following scopes will need to be present on OAuth requests to get data from this field * write:component:compass
deleteComponent?Maybe<DeleteCompassComponentPayload>Deletes an existing component. ### OAuth Scopes The following scopes will need to be present on OAuth requests to get data from this field * write:component:compass
deleteComponentExternalAlias?Maybe<DeleteCompassComponentExternalAliasPayload>Deletes an existing external alias from a component. ### OAuth Scopes The following scopes will need to be present on OAuth requests to get data from this field * write:component:compass
deleteComponentLink?Maybe<DeleteCompassComponentLinkPayload>Deletes an existing link from a component. ### OAuth Scopes The following scopes will need to be present on OAuth requests to get data from this field * write:component:compass
deleteEventSource?Maybe<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. ### Beta Field This field is currently in a beta phase and may change without notice. To use this field you must set a X-ExperimentalApi: compass-prototype HTTP header. Use of this header indicates that they are opting into the experimental preview of this field. If you do not set this header then request will be rejected outright. Once the field moves out of the beta phase, then the header will no longer be required or checked.
deleteMetricDefinition?Maybe<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. ### Beta Field This field is currently in a beta phase and may change without notice. To use this field you must set a X-ExperimentalApi: compass-prototype HTTP header. Use of this header indicates that they are opting into the experimental preview of this field. If you do not set this header then request will be rejected outright. Once the field moves out of the beta phase, then the header will no longer be required or checked.
deleteMetricSource?Maybe<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. ### Beta Field This field is currently in a beta phase and may change without notice. To use this field you must set a X-ExperimentalApi: compass-prototype HTTP header. Use of this header indicates that they are opting into the experimental preview of this field. If you do not set this header then request will be rejected outright. Once the field moves out of the beta phase, then the header will no longer be required or checked.
deleteRelationship?Maybe<DeleteCompassRelationshipPayload>Deletes an existing relationship between two components. ### OAuth Scopes The following scopes will need to be present on OAuth requests to get data from this field * write:component:compass
deleteScorecard?Maybe<DeleteCompassScorecardPayload>Deletes a scorecard. ### OAuth Scopes The following scopes will need to be present on OAuth requests to get data from this field * write:scorecard:compass
deleteScorecardCriterias?Maybe<DeleteCompassScorecardCriteriasPayload>Deletes criteria from a scorecard. ### OAuth Scopes The following scopes will need to be present on OAuth requests to get data from this field * write:scorecard:compass
deleteStarredComponent?Maybe<DeleteCompassStarredComponentPayload>Deletes a starred relationship between a user and a component. ### OAuth Scopes The following scopes will need to be present on OAuth requests to get data from this field * write:component:compass
deleteTeamCheckin?Maybe<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. ### Beta Field This field is currently in a beta phase and may change without notice. To use this field you must set a X-ExperimentalApi: compass-prototype HTTP header. Use of this header indicates that they are opting into the experimental preview of this field. If you do not set this header then request will be rejected outright. Once the field moves out of the beta phase, then the header will no longer be required or checked.
detachComponentDataManager?Maybe<DetachCompassComponentDataManagerPayload>Detach a data manager from a component. ### OAuth Scopes The following scopes will need to be present on OAuth requests to get data from this field * write:component:compass
detachEventSource?Maybe<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. ### Beta Field This field is currently in a beta phase and may change without notice. To use this field you must set a X-ExperimentalApi: compass-prototype HTTP header. Use of this header indicates that they are opting into the experimental preview of this field. If you do not set this header then request will be rejected outright. Once the field moves out of the beta phase, then the header will no longer be required or checked. ### OAuth Scopes The following scopes will need to be present on OAuth requests to get data from this field * write:component:compass
insertMetricValue?Maybe<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. ### Beta Field This field is currently in a beta phase and may change without notice. To use this field you must set a X-ExperimentalApi: compass-prototype HTTP header. Use of this header indicates that they are opting into the experimental preview of this field. If you do not set this header then request will be rejected outright. Once the field moves out of the beta phase, then the header will no longer be required or checked.
removeComponentLabels?Maybe<RemoveCompassComponentLabelsPayload>Removes a collection of existing labels from a component. ### OAuth Scopes The following scopes will need to be present on OAuth requests to get data from this field * write:component:compass
removeScorecardFromComponent?Maybe<RemoveCompassScorecardFromComponentPayload>Removes a scorecard from a component. ### OAuth Scopes The following scopes will need to be present on OAuth requests to get data from this field * write:component:compass
unlinkExternalSource?Maybe<UnlinkExternalSourcePayload>Clean external aliases and data managers pertaining to an externalSource ### OAuth Scopes The following scopes will need to be present on OAuth requests to get data from this field * write:component:compass
updateAnnouncement?Maybe<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. ### Beta Field This field is currently in a beta phase and may change without notice. To use this field you must set a X-ExperimentalApi: compass-prototype HTTP header. Use of this header indicates that they are opting into the experimental preview of this field. If you do not set this header then request will be rejected outright. Once the field moves out of the beta phase, then the header will no longer be required or checked. ### OAuth Scopes The following scopes will need to be present on OAuth requests to get data from this field * write:component:compass
updateComponent?Maybe<UpdateCompassComponentPayload>Updates an existing component. ### OAuth Scopes The following scopes will need to be present on OAuth requests to get data from this field * write:component:compass
updateComponentDataManagerMetadata?Maybe<UpdateCompassComponentDataManagerMetadataPayload>Update a data manager of a component. ### OAuth Scopes The following scopes will need to be present on OAuth requests to get data from this field * write:component:compass
updateComponentLink?Maybe<UpdateCompassComponentLinkPayload>Updates a link from a component. ### OAuth Scopes The following scopes will need to be present on OAuth requests to get data from this field * write:component:compass
updateMetricDefinition?Maybe<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. ### Beta Field This field is currently in a beta phase and may change without notice. To use this field you must set a X-ExperimentalApi: compass-prototype HTTP header. Use of this header indicates that they are opting into the experimental preview of this field. If you do not set this header then request will be rejected outright. Once the field moves out of the beta phase, then the header will no longer be required or checked.
updateScorecard?Maybe<UpdateCompassScorecardPayload>Updates a scorecard. ### OAuth Scopes The following scopes will need to be present on OAuth requests to get data from this field * write:scorecard:compass
updateScorecardCriterias?Maybe<UpdateCompassScorecardCriteriasPayload>Updates criteria on a scorecard. ### OAuth Scopes The following scopes will need to be present on OAuth requests to get data from this field * write:scorecard:compass
updateTeamCheckin?Maybe<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. ### Beta Field This field is currently in a beta phase and may change without notice. To use this field you must set a X-ExperimentalApi: compass-prototype HTTP header. Use of this header indicates that they are opting into the experimental preview of this field. If you do not set this header then request will be rejected outright. Once the field moves out of the beta phase, then the header will no longer be required or checked.

Defined in

graphql-types.ts:2287


CompassCatalogMutationApiAcknowledgeAnnouncementArgs

Ƭ CompassCatalogMutationApiAcknowledgeAnnouncementArgs: Object

The top level wrapper for the Compass Mutations API.

Type declaration

Defined in

graphql-types.ts:2901


CompassCatalogMutationApiAddComponentLabelsArgs

Ƭ CompassCatalogMutationApiAddComponentLabelsArgs: Object

The top level wrapper for the Compass Mutations API.

Type declaration

Defined in

graphql-types.ts:2907


CompassCatalogMutationApiApplyScorecardToComponentArgs

Ƭ CompassCatalogMutationApiApplyScorecardToComponentArgs: Object

The top level wrapper for the Compass Mutations API.

Type declaration

NameType
componentIdScalars"ID"
scorecardIdScalars"ID"

Defined in

graphql-types.ts:2913


CompassCatalogMutationApiAttachComponentDataManagerArgs

Ƭ CompassCatalogMutationApiAttachComponentDataManagerArgs: Object

The top level wrapper for the Compass Mutations API.

Type declaration

Defined in

graphql-types.ts:2920


CompassCatalogMutationApiAttachEventSourceArgs

Ƭ CompassCatalogMutationApiAttachEventSourceArgs: Object

The top level wrapper for the Compass Mutations API.

Type declaration

Defined in

graphql-types.ts:2926


CompassCatalogMutationApiCreateAnnouncementArgs

Ƭ CompassCatalogMutationApiCreateAnnouncementArgs: Object

The top level wrapper for the Compass Mutations API.

Type declaration

Defined in

graphql-types.ts:2932


CompassCatalogMutationApiCreateComponentArgs

Ƭ CompassCatalogMutationApiCreateComponentArgs: Object

The top level wrapper for the Compass Mutations API.

Type declaration

Defined in

graphql-types.ts:2938


CompassCatalogMutationApiCreateComponentExternalAliasArgs

Ƭ CompassCatalogMutationApiCreateComponentExternalAliasArgs: Object

The top level wrapper for the Compass Mutations API.

Type declaration

Defined in

graphql-types.ts:2945


CompassCatalogMutationApiCreateComponentLinkArgs

Ƭ CompassCatalogMutationApiCreateComponentLinkArgs: Object

The top level wrapper for the Compass Mutations API.

Type declaration

Defined in

graphql-types.ts:2951


CompassCatalogMutationApiCreateDeploymentEventArgs

Ƭ CompassCatalogMutationApiCreateDeploymentEventArgs: Object

The top level wrapper for the Compass Mutations API.

Type declaration

Defined in

graphql-types.ts:2957


CompassCatalogMutationApiCreateEventSourceArgs

Ƭ CompassCatalogMutationApiCreateEventSourceArgs: Object

The top level wrapper for the Compass Mutations API.

Type declaration

Defined in

graphql-types.ts:2963


CompassCatalogMutationApiCreateMetricDefinitionArgs

Ƭ CompassCatalogMutationApiCreateMetricDefinitionArgs: Object

The top level wrapper for the Compass Mutations API.

Type declaration

Defined in

graphql-types.ts:2969


CompassCatalogMutationApiCreateMetricSourceArgs

Ƭ CompassCatalogMutationApiCreateMetricSourceArgs: Object

The top level wrapper for the Compass Mutations API.

Type declaration

Defined in

graphql-types.ts:2975


CompassCatalogMutationApiCreateRelationshipArgs

Ƭ CompassCatalogMutationApiCreateRelationshipArgs: Object

The top level wrapper for the Compass Mutations API.

Type declaration

Defined in

graphql-types.ts:2981


CompassCatalogMutationApiCreateScorecardArgs

Ƭ CompassCatalogMutationApiCreateScorecardArgs: Object

The top level wrapper for the Compass Mutations API.

Type declaration

Defined in

graphql-types.ts:2987


CompassCatalogMutationApiCreateScorecardCriteriasArgs

Ƭ CompassCatalogMutationApiCreateScorecardCriteriasArgs: Object

The top level wrapper for the Compass Mutations API.

Type declaration

Defined in

graphql-types.ts:2994


CompassCatalogMutationApiCreateStarredComponentArgs

Ƭ CompassCatalogMutationApiCreateStarredComponentArgs: Object

The top level wrapper for the Compass Mutations API.

Type declaration

Defined in

graphql-types.ts:3001


CompassCatalogMutationApiCreateTeamCheckinArgs

Ƭ CompassCatalogMutationApiCreateTeamCheckinArgs: Object

The top level wrapper for the Compass Mutations API.

Type declaration

Defined in

graphql-types.ts:3008


CompassCatalogMutationApiDeleteAnnouncementArgs

Ƭ CompassCatalogMutationApiDeleteAnnouncementArgs: Object

The top level wrapper for the Compass Mutations API.

Type declaration

Defined in

graphql-types.ts:3014


CompassCatalogMutationApiDeleteComponentArgs

Ƭ CompassCatalogMutationApiDeleteComponentArgs: Object

The top level wrapper for the Compass Mutations API.

Type declaration

Defined in

graphql-types.ts:3020


CompassCatalogMutationApiDeleteComponentExternalAliasArgs

Ƭ CompassCatalogMutationApiDeleteComponentExternalAliasArgs: Object

The top level wrapper for the Compass Mutations API.

Type declaration

Defined in

graphql-types.ts:3026


CompassCatalogMutationApiDeleteComponentLinkArgs

Ƭ CompassCatalogMutationApiDeleteComponentLinkArgs: Object

The top level wrapper for the Compass Mutations API.

Type declaration

Defined in

graphql-types.ts:3032


CompassCatalogMutationApiDeleteEventSourceArgs

Ƭ CompassCatalogMutationApiDeleteEventSourceArgs: Object

The top level wrapper for the Compass Mutations API.

Type declaration

Defined in

graphql-types.ts:3038


CompassCatalogMutationApiDeleteMetricDefinitionArgs

Ƭ CompassCatalogMutationApiDeleteMetricDefinitionArgs: Object

The top level wrapper for the Compass Mutations API.

Type declaration

Defined in

graphql-types.ts:3044


CompassCatalogMutationApiDeleteMetricSourceArgs

Ƭ CompassCatalogMutationApiDeleteMetricSourceArgs: Object

The top level wrapper for the Compass Mutations API.

Type declaration

Defined in

graphql-types.ts:3050


CompassCatalogMutationApiDeleteRelationshipArgs

Ƭ CompassCatalogMutationApiDeleteRelationshipArgs: Object

The top level wrapper for the Compass Mutations API.

Type declaration

Defined in

graphql-types.ts:3056


CompassCatalogMutationApiDeleteScorecardArgs

Ƭ CompassCatalogMutationApiDeleteScorecardArgs: Object

The top level wrapper for the Compass Mutations API.

Type declaration

NameType
scorecardIdScalars"ID"

Defined in

graphql-types.ts:3062


CompassCatalogMutationApiDeleteScorecardCriteriasArgs

Ƭ CompassCatalogMutationApiDeleteScorecardCriteriasArgs: Object

The top level wrapper for the Compass Mutations API.

Type declaration

Defined in

graphql-types.ts:3068


CompassCatalogMutationApiDeleteStarredComponentArgs

Ƭ CompassCatalogMutationApiDeleteStarredComponentArgs: Object

The top level wrapper for the Compass Mutations API.

Type declaration

Defined in

graphql-types.ts:3075


CompassCatalogMutationApiDeleteTeamCheckinArgs

Ƭ CompassCatalogMutationApiDeleteTeamCheckinArgs: Object

The top level wrapper for the Compass Mutations API.

Type declaration

Defined in

graphql-types.ts:3082


CompassCatalogMutationApiDetachComponentDataManagerArgs

Ƭ CompassCatalogMutationApiDetachComponentDataManagerArgs: Object

The top level wrapper for the Compass Mutations API.

Type declaration

Defined in

graphql-types.ts:3088


CompassCatalogMutationApiDetachEventSourceArgs

Ƭ CompassCatalogMutationApiDetachEventSourceArgs: Object

The top level wrapper for the Compass Mutations API.

Type declaration

Defined in

graphql-types.ts:3094


CompassCatalogMutationApiInsertMetricValueArgs

Ƭ CompassCatalogMutationApiInsertMetricValueArgs: Object

The top level wrapper for the Compass Mutations API.

Type declaration

Defined in

graphql-types.ts:3100


CompassCatalogMutationApiRemoveComponentLabelsArgs

Ƭ CompassCatalogMutationApiRemoveComponentLabelsArgs: Object

The top level wrapper for the Compass Mutations API.

Type declaration

Defined in

graphql-types.ts:3106


CompassCatalogMutationApiRemoveScorecardFromComponentArgs

Ƭ CompassCatalogMutationApiRemoveScorecardFromComponentArgs: Object

The top level wrapper for the Compass Mutations API.

Type declaration

NameType
componentIdScalars"ID"
scorecardIdScalars"ID"

Defined in

graphql-types.ts:3112


CompassCatalogMutationApiUnlinkExternalSourceArgs

Ƭ CompassCatalogMutationApiUnlinkExternalSourceArgs: Object

The top level wrapper for the Compass Mutations API.

Type declaration

Defined in

graphql-types.ts:3119


CompassCatalogMutationApiUpdateAnnouncementArgs

Ƭ CompassCatalogMutationApiUpdateAnnouncementArgs: Object

The top level wrapper for the Compass Mutations API.

Type declaration

Defined in

graphql-types.ts:3125


CompassCatalogMutationApiUpdateComponentArgs

Ƭ CompassCatalogMutationApiUpdateComponentArgs: Object

The top level wrapper for the Compass Mutations API.

Type declaration

Defined in

graphql-types.ts:3131


CompassCatalogMutationApiUpdateComponentDataManagerMetadataArgs

Ƭ CompassCatalogMutationApiUpdateComponentDataManagerMetadataArgs: Object

The top level wrapper for the Compass Mutations API.

Type declaration

Defined in

graphql-types.ts:3137


CompassCatalogMutationApiUpdateComponentLinkArgs

Ƭ CompassCatalogMutationApiUpdateComponentLinkArgs: Object

The top level wrapper for the Compass Mutations API.

Type declaration

Defined in

graphql-types.ts:3143


CompassCatalogMutationApiUpdateMetricDefinitionArgs

Ƭ CompassCatalogMutationApiUpdateMetricDefinitionArgs: Object

The top level wrapper for the Compass Mutations API.

Type declaration

Defined in

graphql-types.ts:3149


CompassCatalogMutationApiUpdateScorecardArgs

Ƭ CompassCatalogMutationApiUpdateScorecardArgs: Object

The top level wrapper for the Compass Mutations API.

Type declaration

Defined in

graphql-types.ts:3155


CompassCatalogMutationApiUpdateScorecardCriteriasArgs

Ƭ CompassCatalogMutationApiUpdateScorecardCriteriasArgs: Object

The top level wrapper for the Compass Mutations API.

Type declaration

Defined in

graphql-types.ts:3162


CompassCatalogMutationApiUpdateTeamCheckinArgs

Ƭ CompassCatalogMutationApiUpdateTeamCheckinArgs: Object

The top level wrapper for the Compass Mutations API.

Type declaration

Defined in

graphql-types.ts:3169


CompassCatalogQueryApi

Ƭ CompassCatalogQueryApi: Object

Top level wrapper for Compass Query API

Type declaration

NameTypeDescription
__typename?"CompassCatalogQueryApi"-
component?Maybe<CompassComponentResult>Retrieves a single component by its internal ID. ### OAuth Scopes The following scopes will need to be present on OAuth requests to get data from this field * read:component:compass
componentByExternalAlias?Maybe<CompassComponentResult>Retrieves a single component by its external alias. ### OAuth Scopes The following scopes will need to be present on OAuth requests to get data from this field * read:component:compass
fieldDefinitionsByComponentType?Maybe<CompassFieldDefinitionsResult>Retrieves field definitions by component type.
metricDefinition?Maybe<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. ### Beta Field This field is currently in a beta phase and may change without notice. To use this field you must set a X-ExperimentalApi: compass-prototype HTTP header. Use of this header indicates that they are opting into the experimental preview of this field. If you do not set this header then request will be rejected outright. Once the field moves out of the beta phase, then the header will no longer be required or checked.
metricDefinitions?Maybe<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. ### Beta Field This field is currently in a beta phase and may change without notice. To use this field you must set a X-ExperimentalApi: compass-prototype HTTP header. Use of this header indicates that they are opting into the experimental preview of this field. If you do not set this header then request will be rejected outright. Once the field moves out of the beta phase, then the header will no longer be required or checked.
scorecard?Maybe<CompassScorecardResult>Retrieves a scorecard by its unique identifier (ID). ### OAuth Scopes The following scopes will need to be present on OAuth requests to get data from this field * read:scorecard:compass
scorecards?Maybe<CompassScorecardsQueryResult>Retrieves available scorecards. ### OAuth Scopes The following scopes will need to be present on OAuth requests to get data from this field * read:scorecard:compass
searchComponentLabels?Maybe<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. ### Beta Field This field is currently in a beta phase and may change without notice. To use this field you must set a X-ExperimentalApi: compass-prototype HTTP header. Use of this header indicates that they are opting into the experimental preview of this field. If you do not set this header then request will be rejected outright. Once the field moves out of the beta phase, then the header will no longer be required or checked.
searchComponents?Maybe<CompassComponentQueryResult>Searches for Compass components. ### OAuth Scopes The following scopes will need to be present on OAuth requests to get data from this field * read:component:compass
starredComponents?Maybe<CompassStarredComponentQueryResult>Retrieve all starred components based on the user id. ### OAuth Scopes The following scopes will need to be present on OAuth requests to get data from this field * read:component:compass
teamCheckins?Maybe<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. ### Beta Field This field is currently in a beta phase and may change without notice. To use this field you must set a X-ExperimentalApi: compass-prototype HTTP header. Use of this header indicates that they are opting into the experimental preview of this field. If you do not set this header then request will be rejected outright. Once the field moves out of the beta phase, then the header will no longer be required or checked.

Defined in

graphql-types.ts:3174


CompassCatalogQueryApiComponentArgs

Ƭ CompassCatalogQueryApiComponentArgs: Object

Top level wrapper for Compass Query API

Type declaration

NameType
idScalars"ID"

Defined in

graphql-types.ts:3310


CompassCatalogQueryApiComponentByExternalAliasArgs

Ƭ CompassCatalogQueryApiComponentByExternalAliasArgs: Object

Top level wrapper for Compass Query API

Type declaration

NameType
cloudIdScalars"ID"
externalIDScalars"ID"
externalSource?InputMaybe<Scalars"ID">

Defined in

graphql-types.ts:3316


CompassCatalogQueryApiFieldDefinitionsByComponentTypeArgs

Ƭ CompassCatalogQueryApiFieldDefinitionsByComponentTypeArgs: Object

Top level wrapper for Compass Query API

Type declaration

Defined in

graphql-types.ts:3324


CompassCatalogQueryApiMetricDefinitionArgs

Ƭ CompassCatalogQueryApiMetricDefinitionArgs: Object

Top level wrapper for Compass Query API

Type declaration

NameType
cloudIdScalars"ID"
metricDefinitionIdScalars"ID"

Defined in

graphql-types.ts:3331


CompassCatalogQueryApiMetricDefinitionsArgs

Ƭ CompassCatalogQueryApiMetricDefinitionsArgs: Object

Top level wrapper for Compass Query API

Type declaration

Defined in

graphql-types.ts:3338


CompassCatalogQueryApiScorecardArgs

Ƭ CompassCatalogQueryApiScorecardArgs: Object

Top level wrapper for Compass Query API

Type declaration

NameType
idScalars"ID"

Defined in