Classes
Enumerations
Interfaces
TypeAliases

SyncComponentByExternalAliasInput

Property NameTypeDescription
cloudIdStringId of the Compass site to search for the component/create the component on if it does not already exist.
customFieldsArray<CustomFieldInput>
dataManagerDataManagerInputThe external integration that manages data for this component.
descriptionStringThe description of the component.
eventSourcesArray<CreateEventSourceInput | EventSource>The collection of event sources to sync on the component. If a given event source does not exist on the component, it gets created. If an event source exists in Compass but not in the collection defined here, the event source on Compass gets deleted. If an empty list or null is supplied, the existing event sources on the Compass component are removed. If this value is left undefined, no action is taken on the existing collection of event sources on the Compass component.
externalAliasCompassExternalAliasInputExternal alias to search for the component by.
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 | Link>The collection of links to sync on the component. If a given link does not exist on the component, it gets created. If a link exists in Compass but not in the collection defined here, the link on Compass gets deleted. If an empty list or null is supplied, the existing links on the Compass component are removed. If this value is left undefined, no action is taken on the existing collection of links on the Compass component.
nameStringThe name to apply to the component.
optionsSyncComponentByExternalAliasInputOptionsOptions for how to handle sync behavior.
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.
typeCompassComponentTypeThe type to apply to the component.
typeIdString

Rate this page: