Tableau CRM REST API Developer Guide
jNewer Version Available
Data Connectors List Resource
- 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 category ConnectWaveConnectorCategoryEnum The categories that the data connector belongs to. Valid values are: - AdvancedPropertiesSupport
- BatchRead
- Direct
- FileBased
- FilterSupport
- MuleSoft
- Output
Optional 49.0 connectorType ConnectWaveDataConnectorTypeEnum The type of Tableau CRM connector. The list of valid values can be found here. 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: - CreatedByMe
- Mru (Most Recently Used)
- SharedWithMe
Optional 38.0 - GET Response Body (DataConnectorCollectionRepresentation)
-
Property Name Type Description Filter Group and Version Available Version dataConnectors DataConnectorRepresentation[] A list of Tableau CRM 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 Tableau CRM 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 folder AssetReferenceInputRepresentation The folder for the live connector. Optional 49.0 targetConnector AssetReferenceInputRepresentation The target connector associated with the current source connector. Optional 50.0 The following JSON shows how to create a new Tableau CRM 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 Tableau CRM connector. The list of valid values can be found here. Small, 39.0 39.0 folder AssetReferenceRepresentation The folder for the live connection. Small, 49.0 49.0 ingestionSchedule ScheduleRepresentation Schedule for the Tableau CRM connector data sync. Small, 43.0 43.0 targetConnector AssetReferenceInputRepresentation The target connector associated with the current source connector. Small, 50.0 50.0