getDataConnectorSourceObjectDataPreviewWithFields

Retrieves a preview collection of source fields for a source object used by a CRM Analytics data connector.

Syntax 

1import { LightningElement, api, wire } from "lwc";
2import { getDataConnectorSourceObjectDataPreviewWithFields } from "lightning/analyticsWaveApi";
3
4export default class GetDataConnectorSourceObjectPreviewWithFields extends LightningElement {
5  @api idOrApiName; // or fetch the ID
6  @api soName; // or set the source object name
7  @wire(getDataConnectorSourceObjectDataPreviewWithFields, {
8    connectorIdOrApiName: "$idOrApiName",
9    sourceObjectName: "$soName",
10  })
11  onGetDataConnectorSourceObjectDataPreviewWithFields({ data, error }) {
12    if (error) {
13      console.log("getDataConnectorSourceObjectDataPreviewWithFields ERROR:", error);
14    } else if (data) {
15      console.log("getDataConnectorSourceObjectDataPreviewWithFields RESPONSE:", data.dataListJson);
16    }
17  }
18}

CRM Analytics API Resource 

1GET /wave/dataConnectors/${connectorIdOrApiName}/sourceObjects/${sourceObjectName}/dataPreview

getDataConnectorSourceObjectDataPreviewWithFields uses this CRM Analytics API resource.

Parameters 

Parameter NameTypeDescriptionRequired?
connectorIdOrApiNameStringThe ID or developer name of the data connector.Yes
sourceObjectNameStringThe source object name to request the preview fields for.Yes

Returns