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

Rate this page:

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

Method: getComponent

compass-requests.CompassRequests.getComponent

Callable

getComponent

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

Retrieves a single component by its internal ID.

Required Oauth Scopes

  • read:component:compass

Parameters

NameType
inputGetComponentInput

Returns

Promise<ApiPayload<ComponentPayload>>

Defined in

requests/getComponent.ts:24

Rate this page: