Property NameTypeDescription
currentComponentComponentThe existing component to be updated. This saves one call to getComponent.
dataManagerDataManagerInputThe external integration that manages data for this component.
descriptionStringThe description of the component.
eventSourcesArray<CreateEventSourceInput | EventSource>The updated collection of eventSources to assign to 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.
idStringThe ID of the component being updated.
labelsArray<String>A collection of labels that provide additional contextual information about the component.
linksArray<Link | CreateLinkInput>The updated collection of links to assign to the component.
nameStringThe name of 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.

Rate this page: