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

Rate this page:

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

Method: getComponentByExternalAlias

compass-requests.CompassRequests.getComponentByExternalAlias

Callable

getComponentByExternalAlias

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

Retrieves a single component by its external alias.

Required Oauth Scopes

  • read:component:compass

Parameters

Returns

Promise<ApiPayload<ComponentPayload>>

Defined in

requests/getComponentByExternalAlias.ts:31

Rate this page: