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

Rate this page:

@atlassian/forge-graphql / compound-types / SyncComponentByExternalAliasInput

Interface: SyncComponentByExternalAliasInput

compound-types.SyncComponentByExternalAliasInput

Hierarchy

Properties

cloudId

cloudId: string

Id of the Compass site to search for the component/create the component on if it does not already exist.

Defined in

compound-types.ts:151


dataManager

Optional dataManager: DataManagerInput

The external integration that manages data for this component.

Inherited from

BaseComponentInput.dataManager

Defined in

compound-types.ts:106


description

Optional description: string

The description of the component.

Inherited from

BaseComponentInput.description

Defined in

compound-types.ts:92


eventSources

Optional eventSources: (CreateEventSourceInput | EventSource)[]

The collection of event sources to sync on the component. If a given event source does not exist on the component, it gets created. If an event source exists in Compass but not in the collection defined here, the event source on Compass gets deleted. If an empty list or null is supplied, the existing event sources on the Compass component are removed. If this value is left undefined, no action is taken on the existing collection of event sources on the Compass component.

Overrides

BaseComponentInput.eventSources

Defined in

compound-types.ts:168


externalAlias

externalAlias: CompassExternalAliasInput

External alias to search for the component by.

Overrides

BaseComponentInput.externalAlias

Defined in

compound-types.ts:153


fields

Optional fields: Record<string, string[]>

A collection of fields for storing data about the component. Where the key is the name in the field definition and the value is the CompassFieldValueInput.

Inherited from

BaseComponentInput.fields

Defined in

compound-types.ts:96


labels

Optional labels: string[]

A collection of labels that provide additional contextual information about the component.

Inherited from

BaseComponentInput.labels

Defined in

compound-types.ts:104


Optional links: (CreateLinkInput | Link)[]

The collection of links to sync on the component. If a given link does not exist on the component, it gets created. If a link exists in Compass but not in the collection defined here, the link on Compass gets deleted. If an empty list or null is supplied, the existing links on the Compass component are removed. If this value is left undefined, no action is taken on the existing collection of links on the Compass component.

Overrides

BaseComponentInput.links

Defined in

compound-types.ts:163


name

name: string

The name to apply to the component.

Overrides

BaseComponentInput.name

Defined in

compound-types.ts:155


options

Optional options: Object

Options for how to handle sync behavior.

Type declaration

NameTypeDescription
createComponentIfNotFoundbooleanWhen true, if a component is not found by the external alias, create a new component. When false, if a component is not found by external alias, return an error message. Defaults to true.

Defined in

compound-types.ts:170


ownerId

Optional ownerId: string

The unique identifier (ID) of the team that owns the component.

Inherited from

BaseComponentInput.ownerId

Defined in

compound-types.ts:98


relationships

Optional relationships: Relationship[]

A collection of relationships between the component and other entities in Compass.

Inherited from

BaseComponentInput.relationships

Defined in

compound-types.ts:102


type

type: CompassComponentType

The type to apply to the component.

Defined in

compound-types.ts:157

Rate this page: