Rate this page:
The top level wrapper for the Compass Mutations API.
| Property Name | Type | Description |
|---|---|---|
| __typename | Literal | |
| acknowledgeAnnouncement | Maybe<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. |
| addComponentLabels | Maybe<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. |
| addTeamLabels | Maybe<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. |
| applyScorecardToComponent | Maybe<ApplyCompassScorecardToComponentPayload> | Applies a scorecard to a component. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header. |
| attachComponentDataManager | Maybe<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. |
| attachEventSource | Maybe<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. |
| createAnnouncement | Maybe<CompassCreateAnnouncementPayload> | Creates an announcement for a component. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header. |
| createCompassEvent | Maybe<CompassCreateEventsPayload> | Creates a compass event. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header. |
| createComponent | Maybe<CreateCompassComponentPayload> | Creates a new component. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header. |
| createComponentExternalAlias | Maybe<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. |
| createComponentFromTemplate | Maybe<CreateCompassComponentFromTemplatePayload> | Creates a new component from a given template. |
| createComponentLink | Maybe<CreateCompassComponentLinkPayload> | Creates a link for a component. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header. |
| createComponentSubscription | Maybe<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. |
| createCustomFieldDefinition | Maybe<CompassCreateCustomFieldDefinitionPayload> | Creates a custom field definition. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header. |
| createEventSource | Maybe<CreateEventSourcePayload> | Creates an event source. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header. |
| createMetricDefinition | Maybe<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. |
| createMetricSource | Maybe<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. |
| createRelationship | Maybe<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. |
| createScorecard | Maybe<CreateCompassScorecardPayload> | Creates a scorecard. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header. |
| createScorecardCriterias | Maybe<CreateCompassScorecardCriteriasPayload> | Adds criteria to a scorecard. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header. |
| createTeamCheckin | Maybe<CompassCreateTeamCheckinPayload> | Creates a checkin for a team. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header. |
| deleteAnnouncement | Maybe<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. |
| deleteComponent | Maybe<DeleteCompassComponentPayload> | Deletes an existing component. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header. |
| deleteComponentExternalAlias | Maybe<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. |
| deleteComponentLink | Maybe<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. |
| deleteComponentSubscription | Maybe<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. |
| deleteCustomFieldDefinition | Maybe<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. |
| deleteEventSource | Maybe<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. |
| 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. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header. |
| deleteMetricSource | Maybe<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. |
| deleteRelationship | Maybe<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. |
| deleteScorecard | Maybe<DeleteCompassScorecardPayload> | Deletes a scorecard. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header. |
| deleteScorecardCriterias | Maybe<DeleteCompassScorecardCriteriasPayload> | Deletes criteria from a scorecard. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header. |
| deleteTeamCheckin | Maybe<CompassDeleteTeamCheckinPayload> | Deletes a checkin from a team. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header. |
| detachComponentDataManager | Maybe<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. |
| detachEventSource | Maybe<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. |
| insertMetricValue | Maybe<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. |
| insertMetricValueByExternalId | Maybe<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. |
| removeComponentLabels | Maybe<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. |
| removeScorecardFromComponent | Maybe<RemoveCompassScorecardFromComponentPayload> | Removes a scorecard from a component. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header. |
| removeTeamLabels | Maybe<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. |
| synchronizeLinkAssociations | Maybe<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. |
| unlinkExternalSource | Maybe<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. |
| updateAnnouncement | Maybe<CompassUpdateAnnouncementPayload> | Updates an announcement from a component. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header. |
| updateComponent | Maybe<UpdateCompassComponentPayload> | Updates an existing component. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header. |
| updateComponentDataManagerMetadata | Maybe<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. |
| updateComponentLink | Maybe<UpdateCompassComponentLinkPayload> | Updates a link from a component. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header. |
| updateComponentType | Maybe<UpdateCompassComponentTypePayload> | Updates a component's type. This API is currently in PROTOTYPE. You must provide "X-ExperimentalApi:compass-prototype" in your request header. |
| updateCustomFieldDefinition | Maybe<CompassUpdateCustomFieldDefinitionPayload> | Updates a custom field definition. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header. |
| updateMetricDefinition | Maybe<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. |
| updateScorecard | Maybe<UpdateCompassScorecardPayload> | Updates a scorecard. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header. |
| updateScorecardCriterias | Maybe<UpdateCompassScorecardCriteriasPayload> | Updates criteria on a scorecard. This API is currently in BETA. You must provide "X-ExperimentalApi:compass-beta" in your request header. |
| updateTeamCheckin | Maybe<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: