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

HTTP Methods

GET POST

GET Request Parameters

Parameter Name	Type	Description	Required or Optional	Available Version
connectorType	ConnectWaveDataConnectorTypeEnum	The type of analytics connector. The list of valid values can be found here.	Optional	39.0

GET Response Body (DataConnectorCollectionRepresentation)

Property Name	Type	Description	Filter Group and Version	Available Version
`dataConnectors`	DataConnectorRepresentation[]	A list of analytics connectors.	Small, 39.0	39.0

POST Request Body (DataConnectorInputRepresentation)

DataConnectorInputRepresentation inherits properties from the abstract BaseAssetInputRepresentation. These base properties appear in DataConnectorInputRepresentation alongside the properties defined explicitly in the following table.

Property Name	Type	Description	Required or Optional	Available Version
`connectionProperties`	DataConnectorPropertyInputRepresentation[]	Connection properties for the analytics connector.	Required for POST and PATCH	39.0
`connectorType`	ConnectWaveDataConnectorTypeEnum	The type of the Data Connector. The list of valid values can be found here.	Required for POST; Not allowed to edit in PATCH	39.0

The following JSON shows how to create a new analytics connector, of connectorTypeSalesforceExternall.

1{
2  "label": "My SalesforceExternal Connector",
3  "name" : "mySFDCExt",
4  "description" : "Connection to another Salesforce org.",
5  "connectorType" : "SalesforceExternal",
6  "connectionProperties" : [ {
7    "name" : "Password",
8    "value" : "*******"
9  }, {
10    "name" : "Service_URL",
11    "value" : "https://login.salesforce.com/services/Soap/u/41.0"
12  }, {
13    "name" : "Username",
14    "value" : "user@yourSalesforceOrg.org"
15  }]
16}

POST Response Body (DataConnectorRepresentation)

DataConnectorRepresentation inherits properties from the abstract BaseAssetReferenceRepresentation. These base properties appear in DataConnectorRepresentation alongside the properties defined explicitly in the following table.

Property Name	Type	Description	Filter Group and Version	Available Version
`connectionProperties`	ConnectionPropertyValueRepresentation[]	The connection properties. These are name and value pairs.	Small, 39.0	39.0
`connectorType`	ConnectWaveDataConnectorTypeEnum	The type of analytics connector. The list of valid values can be found here.	Small, 39.0	39.0
ingestionSchedule	ScheduleRepresentation	Schedule for the analytics connector data sync.	Small, 43.0	43.0

DataConnectorPropertyInputRepresentation

Property Name	Type	Description	Required or Optional	Available Version
`name`	String	The name of the connection property.	Required	39.0
`value`	Object	The value of the connection property.	Required	39.0

ConnectionPropertyValueRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`name`	String	The name of the connection property.	Small, 39.0	39.0
`value`	Object	The value of the connection property.	Small, 39.0	39.0

Analytics REST API Developer Guide

Data Connectors List Resource