Data Connector Resource

Resource URL

/wave/dataConnectors/<connectorIdOrApiName>

Formats

JSON

Available Version

39.0

Available in Postman

To view and test a working example of this resource, see getDataConnector in Postman. For information about how to authenticate your org with Postman, see the CRM Analytics Rest API Quick Start.

Available Components

LWC — lightning/analyticsWaveApi getDataConnector()
LWC — lightning/analyticsWaveApi updateDataConnector()
LWC — lightning/analyticsWaveApi deleteDataConnector()

HTTP Methods

DELETE GET PATCH

Request parameters for GET

Parameter Name	Type	Description	Required or Optional	Available Version
`userId`	String	Retrieve the data connector with a user ID.	Optional	55.0

Response body for GET and PATCH

Data Connector

Request body for PATCH

Data Connector Input

The following JSON shows how to edit an existing Analytics connector. The name and connectorType can’t be changed after the Analytics connector is created, only the label, description, and connectionProperties.

{
    "label": "My Salesforce External Connector",
    "description" : "Updated connection to another Salesforce org.",
    "connectionProperties" : [ 
        {
          "name" : "Password",
          "value" : "*******"
        }, {
          "name" : "Service_URL",
          "value" : "https://MyDomainName.my.salesforce.com
/services/Soap/u/41.0"
        }, {
          "name" : "Username",
          "value" : "user@yourSalesforceOrg.org"
      }
    ]
}

Schedule a Connection

To schedule a connection, use the Schedule Resource API. For examples of how to schedule dataflows, recipes, and data syncs, see Schedule Dataflows, Recipes, and Data Syncs