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

Rate this page:

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

Interface: Component

compound-types.Component

Properties

dataManager

Optional dataManager: UpdateCompassComponentDataManagerMetadataInput | DataManagerInput

The external integration that manages data for this component.

Defined in

compound-types.ts:79


description

Optional description: string

The description of the component.

Defined in

compound-types.ts:65


eventSources

Optional eventSources: CreateEventSourceInput[]

The event sources associated to the component.

Defined in

compound-types.ts:81


externalAliases

Optional externalAliases: CompassExternalAlias[]

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

Defined in

compound-types.ts:83


fields

Optional fields: Record<string, object>

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:69


id

id: string

The unique identifier (ID) of the component.

Defined in

compound-types.ts:59


labels

Optional labels: string[]

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

Defined in

compound-types.ts:77


Optional links: Link[]

A collection of links to other entities on the internet.

Defined in

compound-types.ts:73


name

name: string

The name of the component.

Defined in

compound-types.ts:61


ownerId

Optional ownerId: string

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

Defined in

compound-types.ts:71


relationships

Optional relationships: Relationship[]

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

Defined in

compound-types.ts:75


type

type: CompassComponentType

The type of the component.

Defined in

compound-types.ts:63

Rate this page: