Classes
Enumerations
Interfaces
TypeAliases

CompassCatalogMutationApi

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
__typenameLiteral
acknowledgeAnnouncementMaybe<CompassAcknowledgeAnnouncementPayload>Acknowledges an announcement on behalf of a component.
addComponentLabelsMaybe<AddCompassComponentLabelsPayload>Adds a collection of labels to a component.
addTeamLabelsMaybe<CompassAddTeamLabelsPayload>Adds labels to a team within Compass.
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.
createAnnouncementMaybe<CompassCreateAnnouncementPayload>Creates an announcement for a component.
createAssistantAnswerMaybe<CompassCreateAssistantAnswerPayload>Starts the creation of a Compass assistant answer based on the user-provided question
createCompassEventMaybe<CompassCreateEventsPayload>Creates a compass event.
createComponentMaybe<CreateCompassComponentPayload>Creates a new component.
createComponentExternalAliasMaybe<CreateCompassComponentExternalAliasPayload>Creates an external alias for a component.
createComponentFromTemplateMaybe<CreateCompassComponentFromTemplatePayload>Creates a new component from a given template.
createComponentLinkMaybe<CreateCompassComponentLinkPayload>Creates a link for a component.
createComponentScorecardJiraIssueMaybe<CompassCreateComponentScorecardJiraIssuePayload>Creates a Jira issue for a component scorecard relationship.
createComponentSubscriptionMaybe<CompassCreateComponentSubscriptionPayload>Creates a subscription to a component for current user.
createCustomFieldDefinitionMaybe<CompassCreateCustomFieldDefinitionPayload>Creates a custom field definition.
createEventSourceMaybe<CreateEventSourcePayload>Creates an event source.
createIncomingWebhookMaybe<CompassCreateIncomingWebhookPayload>Creates an incoming webhook that can be invoked to send events to Compass.
createIncomingWebhookTokenMaybe<CompassCreateIncomingWebhookTokenPayload>Creates a token for a Compass incoming webhook
createMetricDefinitionMaybe<CompassCreateMetricDefinitionPayload>Creates a metric definition on a Compass site. A metric definition provides details for a metric source.
createMetricSourceMaybe<CompassCreateMetricSourcePayload>Creates a metric source for a component. A metric source contains values providing numerical data about a component.
createRelationshipMaybe<CreateCompassRelationshipPayload>Creates a new relationship between two components.
createScorecardMaybe<CreateCompassScorecardPayload>Creates a scorecard.
createStarredComponentMaybe<CreateCompassStarredComponentPayload>Creates a starred relationship between a user and a component.
createTeamCheckinMaybe<CompassCreateTeamCheckinPayload>Creates a checkin for a team.
createWebhookMaybe<CompassCreateWebhookPayload>Creates a webhook to be used after a component is created from a template.
deleteAnnouncementMaybe<CompassDeleteAnnouncementPayload>Deletes an existing announcement from a component.
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.
deleteComponentSubscriptionMaybe<CompassDeleteComponentSubscriptionPayload>Deletes a subscription to a component for current user.
deleteCustomFieldDefinitionMaybe<CompassDeleteCustomFieldDefinitionPayload>Deletes a custom field definition, along with all values associated with the definition.
deleteEventSourceMaybe<DeleteEventSourcePayload>Deletes an event source and all the corresponding events from that event source.
deleteIncomingWebhookMaybe<CompassDeleteIncomingWebhookPayload>Deletes an incoming webhook from Compass.
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.
deleteMetricSourceMaybe<CompassDeleteMetricSourcePayload>Deletes a metric source including the metric values it contains.
deleteRelationshipMaybe<DeleteCompassRelationshipPayload>Deletes an existing relationship between two components.
deleteScorecardMaybe<DeleteCompassScorecardPayload>Deletes a scorecard.
deleteStarredComponentMaybe<DeleteCompassStarredComponentPayload>Deletes a starred relationship between a user and a component.
deleteTeamCheckinMaybe<CompassDeleteTeamCheckinPayload>Deletes a checkin from a team.
detachComponentDataManagerMaybe<DetachCompassComponentDataManagerPayload>Detach a data manager from a component.
detachEventSourceMaybe<DetachEventSourcePayload>Detaches an event source from a component.
insertMetricValueMaybe<CompassInsertMetricValuePayload>Inserts a metric value in a metric source for a component.
insertMetricValueByExternalIdMaybe<CompassInsertMetricValueByExternalIdPayload>Inserts metric values into metric sources using the external ID of the source, except when a Forge app created the metric, and you're not that same Forge app.
removeComponentLabelsMaybe<RemoveCompassComponentLabelsPayload>Removes a collection of existing labels from a component.
removeScorecardFromComponentMaybe<RemoveCompassScorecardFromComponentPayload>Removes a scorecard from a component.
removeTeamLabelsMaybe<CompassRemoveTeamLabelsPayload>Removes labels from a team within Compass.
synchronizeLinkAssociationsMaybe<CompassSynchronizeLinkAssociationsPayload>Synchronizes event and metric information for the current set of component links on a Compass site using the provided Forge app.
unlinkExternalSourceMaybe<UnlinkExternalSourcePayload>Clean external aliases and data managers pertaining to an externalSource
updateAnnouncementMaybe<CompassUpdateAnnouncementPayload>Updates an announcement from a component.
updateComponentMaybe<UpdateCompassComponentPayload>Updates an existing component.
updateComponentDataManagerMetadataMaybe<UpdateCompassComponentDataManagerMetadataPayload>Update a data manager of a component.
updateComponentLinkMaybe<UpdateCompassComponentLinkPayload>Updates a link from a component.
updateComponentScorecardJiraIssueMaybe<CompassUpdateComponentScorecardJiraIssuePayload>Updates a Jira issue for a component scorecard relationship.
updateComponentTypeMaybe<UpdateCompassComponentTypePayload>Updates a component's type.
updateCustomFieldDefinitionMaybe<CompassUpdateCustomFieldDefinitionPayload>Updates a custom field definition.
updateMetricDefinitionMaybe<CompassUpdateMetricDefinitionPayload>Updates a metric definition on a Compass site.
updateScorecardMaybe<UpdateCompassScorecardPayload>Updates a scorecard.
updateTeamCheckinMaybe<CompassUpdateTeamCheckinPayload>Updates a checkin for a team.
updateUserDefinedParametersMaybe<UpdateCompassUserDefinedParametersPayload>Creates, updates, and deletes parameters from a given component

Rate this page: