Data Connectors List Resource

Returns a collection of Analytics connectors and creates an Analytics connector.

Resource URL

1/wave/dataConnectors

Formats

JSON

Available Version

39.0

Available Components

LWC — lightning/analyticsWaveApi getDataConnectors()
LWC — lightning/analyticsWaveApi createDataConnector()

HTTP Methods

GET POST

Request parameters for GET

Parameter Name	Type	Description	Required or Optional	Available Version
`category`	ConnectWaveConnectorCategoryEnum	The categories that the data connector belongs to. Valid values are: `AdvancedPropertiesSupport` `BatchRead` `Direct` `FileBased` `FilterSupport` `Output`	Optional	49.0
`connectorType`	ConnectWaveDataConnectorTypeEnum	For a full list of the data connector types, see the enum description.	Optional	39.0
`folderId`	Id	Filters the results to include on the contents of a specific folder. The id can be the requesting user's ID for items in the user's private folder.	Optional	49.0
`scope`	ConnectWaveScopeTypeEnum	The type of scope to be applied to the returned collection. Valid values are: `Browse` `CreatedByMe` `InsightsApplicationsIsCansEdit` `Mru` (Most Recently Used) `SharedWithMe`	Optional	38.0

Response body for GET

Data Connector Collection

Request body for POST

Data Connector Input

The following JSON shows how to create a new Analytics connector, of connectorType SalesforceExternal.

1{
2  "label": "My SalesforceExternal Connector",
3  "name" : "mySFDCExt",
4  "description" : "Connection to another Salesforce org.",
5  "connectorType" : "SalesforceExternal",
6  "connectorHandler" : "Legacy",
7  "connectionProperties" : [ {
8      "name" : "Password",
9      "value" : "*******"
10    }, {
11      "name" : "Service_URL",
12      "value" : "https://MyDomainName.my.salesforce.com
13/services/Soap/u/53.0"
14    }, {
15      "name" : "Username",
16      "value" : "user@yourSalesforceOrg.org"
17    }, {
18      "name" : "APIType",
19      "value" : "BULKV2"
20    }
21  ]
22}

Response body for POST

Data Connector

CRM Analytics REST API Developer Guide