getDataConnectors

Retrieves a collection of CRM Analytics data connectors.

Syntax 

1import { LightningElement, wire } from "lwc";
2import { getDataConnectors } from "lightning/analyticsWaveApi";
3
4export default class GetDataConnectors extends LightningElement {
5  @wire(getDataConnectors, {
6    connectorType: ["SfdcLocal"],
7  })
8  onGetDataConnectors({ data, error }) {
9    if (error) {
10      console.log("getDataConnectors ERROR:", error);
11    } else if (data) {
12      console.log("getDataConnectors RESPONSE:", data.dataConnectors);
13    }
14  }
15}

CRM Analytics API Resource 

1GET /wave/dataConnectors

getDataConnectors uses this CRM Analytics API resource.

Parameters 

These parameters are optional.

Parameter NameTypeDescription
categoryStringFilters the collection to include only data connectors belonging to the specified category.
  • AdvancedPropertiesSupport (Connector supports Advanced Properties)
  • BatchRead (Read/Input Connector that performs batch reads, instead of live queries)
  • Direct (Direct/Live Connector)
  • FileBased (File-based Connector)
  • FilterSupport (Connector supports pass-through filter)
  • MuleSoft (MuleSoft Connector)
  • Output (Write/Output/Target Connector)
  • Private (Private Connector that performs batch reads instead of live queries)
connectorTypeStringFilters the collection to include only data connectors belonging to the specified connector type. The list of valid values can be found here.
folderIdStringFilters the collection to only contain data connectors for the specified folder. The ID can be the requesting user’s ID for data connectors in the user’s private folder.
scopeStringScope type to apply to the collection results.
  • CreatedByMe
  • Mru (Most Recently Used)
  • SharedWithMe

Returns