Classes
Enumerations
Interfaces
TypeAliases

CreateComponentInput

Property NameTypeDescription
cloudIdStringId of the Compass site to create the component on.
customFieldsArray<CustomFieldInput>
dataManagerDataManagerInputThe external integration that manages data for this component.
descriptionStringThe description of the component.
externalAliasCompassExternalAliasInputThe event sources associated to the component.
fieldsRecord<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.
labelsArray<String>A collection of labels that provide additional contextual information about the component.
linksArray<CreateLinkInput>A collection of links to other entities on the internet.
nameStringThe name of the component.
optionsCreateComponentOptionsOptions for how to create the component
ownerIdStringThe unique identifier (ID) of the team that owns the component.
relationshipsArray<Relationship>A collection of relationships between the component and other entities in Compass.
stateComponentStateThe state of the component
typeCompassComponentTypeThe type of the component.
typeIdString

Rate this page: