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

Rate this page:

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

Interface: CreateComponentInput

compound-types.CreateComponentInput

Hierarchy

Properties

cloudId

cloudId: string

Id of the Compass site to create the component on.

Defined in

compound-types.ts:209


dataManager

Optional dataManager: DataManagerInput

The external integration that manages data for this component.

Inherited from

BaseComponentInput.dataManager

Defined in

compound-types.ts:135


description

Optional description: string

The description of the component.

Inherited from

BaseComponentInput.description

Defined in

compound-types.ts:121


eventSources

Optional eventSources: CreateEventSourceInput[]

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

Inherited from

BaseComponentInput.eventSources

Defined in

compound-types.ts:139


externalAlias

Optional externalAlias: CompassExternalAliasInput

The event sources associated to the component.

Inherited from

BaseComponentInput.externalAlias

Defined in

compound-types.ts:137


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


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


Optional links: CreateLinkInput[]

A collection of links to other entities on the internet.

Inherited from

BaseComponentInput.links

Defined in

compound-types.ts:129


name

name: string

The name of the component.

Overrides

BaseComponentInput.name

Defined in

compound-types.ts:211


ownerId

Optional ownerId: string

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

Inherited from

BaseComponentInput.ownerId

Defined in

compound-types.ts:127


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


type

type: CompassComponentType

The type of the component.

Defined in

compound-types.ts:213

Rate this page: