Classes
Enumerations
Interfaces
TypeAliases

Rate this page:

CompassCatalogMutationApi

The top level wrapper for the Compass Mutations API.

Property NameTypeDescription
__typenameLiteral
acknowledgeAnnouncementMaybe<CompassAcknowledgeAnnouncementPayload>Acknowledges an announcement on behalf of a component. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header.
addComponentLabelsMaybe<AddCompassComponentLabelsPayload>Adds a collection of labels to a component. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
addTeamLabelsMaybe<CompassAddTeamLabelsPayload>Adds labels to a team within Compass. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header.
applyScorecardToComponentMaybe<ApplyCompassScorecardToComponentPayload>Applies a scorecard to a component. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
attachComponentDataManagerMaybe<AttachCompassComponentDataManagerPayload>Attach a data manager to a component. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
attachEventSourceMaybe<AttachEventSourcePayload>Attaches an event source to a component. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
createAnnouncementMaybe<CompassCreateAnnouncementPayload>Creates an announcement for a component. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header.
createCompassEventMaybe<CompassCreateEventsPayload>Creates a compass event. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
createComponentMaybe<CreateCompassComponentPayload>Creates a new component. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
createComponentExternalAliasMaybe<CreateCompassComponentExternalAliasPayload>Creates an external alias for a component. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
createComponentFromTemplateMaybe<CreateCompassComponentFromTemplatePayload>Creates a new component from a given template.
createComponentLinkMaybe<CreateCompassComponentLinkPayload>Creates a link for a component. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
createComponentSubscriptionMaybe<CompassCreateComponentSubscriptionPayload>Creates a subscription to a component for current user. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header.
createCustomFieldDefinitionMaybe<CompassCreateCustomFieldDefinitionPayload>Creates a custom field definition. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
createEventSourceMaybe<CreateEventSourcePayload>Creates an event source. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
createMetricDefinitionMaybe<CompassCreateMetricDefinitionPayload>Creates a metric definition on a Compass site. A metric definition provides details for a metric source. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header.
createMetricSourceMaybe<CompassCreateMetricSourcePayload>Creates a metric source for a component. A metric source contains values providing numerical data about a component. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header.
createRelationshipMaybe<CreateCompassRelationshipPayload>Creates a new relationship between two components. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
createScorecardMaybe<CreateCompassScorecardPayload>Creates a scorecard. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
createScorecardCriteriasMaybe<CreateCompassScorecardCriteriasPayload>Adds criteria to a scorecard. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
createTeamCheckinMaybe<CompassCreateTeamCheckinPayload>Creates a checkin for a team. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header.
deleteAnnouncementMaybe<CompassDeleteAnnouncementPayload>Deletes an existing announcement from a component. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header.
deleteComponentMaybe<DeleteCompassComponentPayload>Deletes an existing component. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
deleteComponentExternalAliasMaybe<DeleteCompassComponentExternalAliasPayload>Deletes an existing external alias from a component. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
deleteComponentLinkMaybe<DeleteCompassComponentLinkPayload>Deletes an existing link from a component. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
deleteComponentSubscriptionMaybe<CompassDeleteComponentSubscriptionPayload>Deletes a subscription to a component for current user. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header.
deleteCustomFieldDefinitionMaybe<CompassDeleteCustomFieldDefinitionPayload>Deletes a custom field definition, along with all values associated with the definition. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
deleteEventSourceMaybe<DeleteEventSourcePayload>Deletes an event source and all the corresponding events from that event source. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
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. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header.
deleteMetricSourceMaybe<CompassDeleteMetricSourcePayload>Deletes a metric source including the metric values it contains. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header.
deleteRelationshipMaybe<DeleteCompassRelationshipPayload>Deletes an existing relationship between two components. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
deleteScorecardMaybe<DeleteCompassScorecardPayload>Deletes a scorecard. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
deleteScorecardCriteriasMaybe<DeleteCompassScorecardCriteriasPayload>Deletes criteria from a scorecard. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
deleteTeamCheckinMaybe<CompassDeleteTeamCheckinPayload>Deletes a checkin from a team. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header.
detachComponentDataManagerMaybe<DetachCompassComponentDataManagerPayload>Detach a data manager from a component. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
detachEventSourceMaybe<DetachEventSourcePayload>Detaches an event source from a component. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
insertMetricValueMaybe<CompassInsertMetricValuePayload>Inserts a metric value in a metric source for a component. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header.
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. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header.
removeComponentLabelsMaybe<RemoveCompassComponentLabelsPayload>Removes a collection of existing labels from a component. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
removeScorecardFromComponentMaybe<RemoveCompassScorecardFromComponentPayload>Removes a scorecard from a component. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
removeTeamLabelsMaybe<CompassRemoveTeamLabelsPayload>Removes labels from a team within Compass. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header.
synchronizeLinkAssociationsMaybe<CompassSynchronizeLinkAssociationsPayload>Synchronizes event and metric information for the current set of component links on a Compass site using the provided Forge app. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
unlinkExternalSourceMaybe<UnlinkExternalSourcePayload>Clean external aliases and data managers pertaining to an externalSource This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
updateAnnouncementMaybe<CompassUpdateAnnouncementPayload>Updates an announcement from a component. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header.
updateComponentMaybe<UpdateCompassComponentPayload>Updates an existing component. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
updateComponentDataManagerMetadataMaybe<UpdateCompassComponentDataManagerMetadataPayload>Update a data manager of a component. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
updateComponentLinkMaybe<UpdateCompassComponentLinkPayload>Updates a link from a component. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
updateComponentTypeMaybe<UpdateCompassComponentTypePayload>Updates a component's type. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header.
updateCustomFieldDefinitionMaybe<CompassUpdateCustomFieldDefinitionPayload>Updates a custom field definition. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
updateMetricDefinitionMaybe<CompassUpdateMetricDefinitionPayload>Updates a metric definition on a Compass site. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header.
updateScorecardMaybe<UpdateCompassScorecardPayload>Updates a scorecard. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
updateScorecardCriteriasMaybe<UpdateCompassScorecardCriteriasPayload>Updates criteria on a scorecard. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header.
updateTeamCheckinMaybe<CompassUpdateTeamCheckinPayload>Updates a checkin for a team. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header.

Rate this page: