Property Name | Type | Description |
---|---|---|
cloudId | String | Id of the Compass site to create the component on. |
customFields | Array<CustomFieldInput> | |
dataManager | DataManagerInput | The external integration that manages data for this component. |
description | String | The description of the component. |
externalAlias | CompassExternalAliasInput | The event sources associated to the component. |
fields | Record<String, Array<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. |
labels | Array<String> | A collection of labels that provide additional contextual information about the component. |
links | Array<CreateLinkInput> | A collection of links to other entities on the internet. |
name | String | The name of the component. |
options | CreateComponentOptions | Options for how to create the component |
ownerId | String | The unique identifier (ID) of the team that owns the component. |
relationships | Array<Relationship> | A collection of relationships between the component and other entities in Compass. |
state | ComponentState | The state of the component |
type | CompassComponentType | The type of the component. |
typeId | String |
Rate this page: