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

Rate this page:

@atlassian/forge-graphql / compass-requests / CompassRequests / syncComponentByExternalAlias

Method: syncComponentByExternalAlias

compass-requests.CompassRequests.syncComponentByExternalAlias

Callable

syncComponentByExternalAlias

syncComponentByExternalAlias(input): Promise<ApiPayload<ComponentPayload>>

Creates a component if it's external alias does not exist or updates the component if the external alias does exist.

Required Oauth Scopes

  • write:component:compass
  • write:event:compass

Parameters

Returns

Promise<ApiPayload<ComponentPayload>>

Defined in

requests/syncComponentByExternalAlias.ts:26

Rate this page: