Rate this page:
Requests to make to Atlassian GraphQL Gateway, scoped to Compass related configuration as code entities and actions.
new ConfigAsCodeRequests(api: Default, cr: CompassRequests): ConfigAsCodeRequests
1 2const configAsCodeRequests = new ConfigAsCodeRequests( {} )
Property Name | Type | Description |
---|---|---|
api | Default | |
requests | CompassRequests |
syncComponentWithFile(input: SyncComponentWithFileInput): Promise<ApiPayload<ComponentPayload>>
Updates a component with data coming from the configuration as code file.
Required Oauth Scopes: write:component:compass
1 2const resp = configAsCodeRequests.syncComponentWithFile( { "additionalExternalAliases": [ { "externalId": "string", "externalSource": "string" } ], "additionalLinks": [ { "name": "string", "type": "CHAT_CHANNEL", "url": "string" } ], "cloudId": "2d492f5d-068a-4e9c-a9d3-3618589b56c1", "configFile": "string", "externalSourceURL": "string", "immutableLocalKeyPrefix": "string" } )
Rate this page: