Rate this page:
Property Name | Type | Description |
---|---|---|
metricSources | Array<CompassMetricSource> | |
pageInfo | PageInfo |
Options for what to include in individual component results
Property Name | Type | Description |
---|---|---|
includeEventSources | Boolean | Include event sources in the results |
includeLinks | Boolean | Include links in the results |
includeMetricSources | Boolean | Include metric sources in the results |
Property Name | Type | Description |
---|---|---|
componentId | String | Component id of component to retrieve |
options | GetOptions | Options for what to include in search results |
Property Name | Type | Description |
---|---|---|
includeMetricSources | Boolean | Include metric sources in the results |
Property Name | Type | Description |
---|---|---|
after | String | Returns results after the specified cursor. |
cloudId | String | The cloud ID of the site to query for metric definitions on. |
first | Number | The number of results to return in the query. The default is 10. |
options | GetMetricDefinitionsOptions | Options for what to include in search results |
Property Name | Type | Description |
---|---|---|
cloudId | String | Cloud id of Compass site that the Component exists on |
options | SearchComponentsOptions | Options for what to include in search results. |
query | CompassSearchComponentQuery | The query to find components |
Property Name | Type | Description |
---|---|---|
cloudId | String | Cloud id of Compass site that the Component exists on |
externalId | String | The ID of the component in an external system |
externalSource | String | The external system hosting the component |
options | GetComponentByExternalAliasOptions | Options for what to include in search results |
Property Name | Type | Description |
---|---|---|
componentId | String | Component id that created event source will be attached to |
eventSource | CreateEventSourceInput | Event source to create |
Property Name | Type | Description |
---|---|---|
componentId | String | |
newEventSources | Array<CreateEventSourceInput> | |
oldEventSources | Array<EventSource> |
Property Name | Type | Description |
---|---|---|
nodeId | String | The end node of relationship. |
type | DependsOn | The type of relationship. |
Property Name | Type | Description |
---|---|---|
changeMetadata | CompassChangeMetadata | Metadata about who created the component and when. |
customFields | Array<CompassCustomTextField | CompassCustomNumberField | CompassCustomBooleanField> | |
dataManager | UpdateCompassComponentDataManagerMetadataInput | DataManagerInput | The external integration that manages data for this component. |
description | String | The description of the component. |
eventSources | Array<EventSource> | The event sources associated to the component. |
externalAliases | Array<CompassExternalAlias> | A collection of aliases that represent the component in external systems. |
fields | Record<String, Unknown> | 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 unique identifier (ID) of the component. |
labels | Array<String> | A collection of labels that provide additional contextual information about the component. |
links | Array<Link> | A collection of links to other entities on the internet. |
metricSources | Array<CompassMetricSource> | The metric source associated 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. |
type | CompassComponentType | The type of the component. |
typeId | String | The unique identifier for the type of the Component. |
Property Name | Type | Description |
---|---|---|
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. |
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. |
Error stemming from Graphql Gateway schema.
Property Name | Type | Description |
---|---|---|
extensions | GqlErrorExtensions | |
message | String | A human readable error message. |
Property Name | Type | Description |
---|---|---|
classification | String | Application specific error classification. |
errorSource | String | Application layer in which the error occurred. |
errorType | String | Application specific error type. |
Property Name | Type | Description |
---|---|---|
errorType | String | Application specific error type. |
statusCode | Number | Application layer in which the error occurred. |
Error stemming from Compass Catalog.
Property Name | Type | Description |
---|---|---|
extensions | MutationErrorExtensions | Array<MutationErrorExtensions> | |
message | String | A human readable error message. |
Error that gets returned from requests.
Property Name | Type | Description |
---|---|---|
errorSource | String | Application layer in which the error occurred. |
errorType | String | Application specific error type. |
message | String | A human readable error message. |
statusCode | Number | A numerical code (such as a HTTP status code) representing the error category |
Error steming from a Forge inocation
Property Name | Type | Description |
---|---|---|
error | String | |
options | ForgeInvocationErrorOptions | |
statusCode | InvocationStatusCode |
Property Name | Type | Description |
---|---|---|
createComponentIfNotFound | Boolean | When true, if a component is not found by the external alias, create a new component. When false, if a component is not found by external alias, return an error message. Defaults to true. |
Property Name | Type | Description |
---|---|---|
cloudId | String | Id of the Compass site to search for the component/create the component on if it does not already exist. |
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 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. |
externalAlias | CompassExternalAliasInput | External alias to search for the component by. |
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<Link | CreateLinkInput> | 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. |
name | String | The name to apply to the component. |
options | SyncComponentByExternalAliasInputOptions | Options for how to handle sync behavior. |
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. |
type | CompassComponentType | The type to apply to the component. |
typeId | String | The type to apply to the component. |
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. |
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. |
type | CompassComponentType | The type of the component. |
typeId | String | The unique identifier for the type of the Component. |
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<Link | CreateLinkInput> | 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. |
Property Name | Type | Description |
---|---|---|
eventSources | Array<EventSource> | Collection of event sources returned by a request. |
Property Name | Type | Description |
---|---|---|
eventSource | EventSource | Event source returned by a request. |
Property Name | Type | Description |
---|---|---|
labelNames | Array<CompassComponentLabel> | Collection of labels returned by a request. |
Property Name | Type | Description |
---|---|---|
component | Component | Component details returned by a request. |
Property Name | Type | Description |
---|---|---|
metricDefinition | CompassMetricDefinition | Metric definition returned by a request |
Property Name | Type | Description |
---|---|---|
metricDefinitions | Array<CompassMetricDefinition> | Metric definitions returned by a request |
pageInfo | PageInfo |
Property Name | Type | Description |
---|---|---|
externalAlias | CompassExternalAlias | External alias returned by a request. |
Property Name | Type | Description |
---|---|---|
link | CompassLink | Component link returned by a request. |
Property Name | Type | Description |
---|---|---|
relationship | CompassRelationship | Component relationship returned by a request. |
Property Name | Type | Description |
---|---|---|
id | String | Id returned by a request. |
Property Name | Type | Description |
---|---|---|
metricSourceId | String | Id returned by a request. |
Property Name | Type | Description |
---|---|---|
components | Array<Component> | Component details returned by a request. |
pageInfo | PageInfo |
Property Name | Type | Description |
---|---|---|
eventsQuery | CompassEventsInEventSourceQuery | |
includeEvents | Boolean |
Property Name | Type | Description |
---|---|---|
cloudId | String | |
eventType | CompassEventType | |
externalEventSourceId | String | |
options | GetEventSourceInputOptions |
Property Name | Type | Description |
---|---|---|
customFieldDefinition | CompassCustomFieldDefinition |
Rate this page: