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

Rate this page:

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

Interface: BaseComponentInput

compound-types.BaseComponentInput

Hierarchy

Properties

dataManager

Optional dataManager: DataManagerInput

The external integration that manages data for this component.

Defined in

compound-types.ts:106


description

Optional description: string

The description of the component.

Defined in

compound-types.ts:92


eventSources

Optional eventSources: CreateEventSourceInput[]

A collection of aliases that represent the component in external systems.

Defined in

compound-types.ts:110


externalAlias

Optional externalAlias: CompassExternalAliasInput

The event sources associated to the component.

Defined in

compound-types.ts:108


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.

Defined in

compound-types.ts:96


labels

Optional labels: string[]

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

Defined in

compound-types.ts:104


Optional links: CreateLinkInput[]

A collection of links to other entities on the internet.

Defined in

compound-types.ts:100


name

Optional name: string

The name of the component.

Defined in

compound-types.ts:90


ownerId

Optional ownerId: string

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

Defined in

compound-types.ts:98


relationships

Optional relationships: Relationship[]

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

Defined in

compound-types.ts:102

Rate this page: