Property Name | Type | Description |
---|---|---|
currentComponent | Component | The existing component to be updated. This saves one call to getComponent. |
customFields | Array<CustomFieldInput> | |
dataManager | DataManagerInput | The external integration that manages data for this component. |
description | String | The description of the component. |
eventSources | Array<CreateEventSourceInput | EventSource> | The updated collection of eventSources to assign to 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. |
id | String | The ID of the component being updated. |
labels | Array<String> | A collection of labels that provide additional contextual information about the component. |
links | Array<CreateLinkInput | Link> | The updated collection of links to assign to the component. |
name | String | The name of 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. |
slug | String | The unique slug of the component. |
typeId | String |
Rate this page: