Analytics REST API Developer Guide
jNewer Version Available
Replicated Datasets List Resource
- Resource URL
-
1/wave/replicatedDatasets - Formats
- JSON
- Available Version
- 37.0
- HTTP Methods
- GET POST
- GET Request Parameters
-
Parameter Name Type Description Required or Optional Available Version connector String Filter the list of returned connected objects by specifying the name of an analytics connector. Optional 37.0 sourceObject String Filter the list of returned connected objects by specifying the name of a source object. Optional 37.0 - GET Response Body (ReplicatedDatasetCollectionRepresentation)
-
Property Name Type Description Filter Group and Version Available Version replicatedDatasets ReplicatedDatasetRepresentation[] A list of connected objects. Small, 37.0 37.0 url String The URL to get the collection. Small, 37.0 37.0 - POST Request Body (ReplicatedDatasetInputRepresentation)
-
Property Name Type Description Required or Optional Available Version advancedProperties AdvancedPropertyValueRepresentation The user-specified advanced properties associated with this connected object. Optional 44.0 connectionMode ConnectWaveConnectionModeEnum The connection mode for data sync. It is recommended to use Incremental or PeriodicFull to make extracts faster. Valid values are: - Full
- Incremental
- PeriodicFull
Optional 46.0 connectorId String The id of the analytics connector used to sync this connected object. Required 39.0 fullRefresh Boolean Whether to perform a one-time full refresh during the next run as opposed to an incremental refresh. Optional 41.0 passThroughFilter String The pass through filter for the connected object Optional 38.0 sourceObjectName String The name of the source object to be synced. Required 37.0 The following JSON shows how to create a connected object from an analytics connector.
1{ 2 "connectorId": "0ItS7000000xxxxxxx", 3 "sourceObjectName": "Account" 4} - POST Response Body (ReplicatedDatasetRepresentation)
-
ReplicatedDatasetRepresentation inherits properties from the abstract BaseWaveAssetRepresentation. These base properties appear in ReplicatedDatasetRepresentation alongside the properties defined explicitly in the following table.
Property Name Type Description Filter Group and Version Available Version advancedProperties AdvancedPropertyValueRepresentation The advanced properties associated with this connected object. Small, v44.0 44.0 connectionMode ConnectWaveConnectionModeEnum The connection mode for data sync. It is recommended to use Incremental or PeriodicFull to make extracts faster. Valid values are: - Full
- Incremental
- PeriodicFull
Small, 46.0 46.0 connector DataConnectorRepresentation Analytics connector information associated with this connected object Small, 37.0 37.0 datasetId String The ID of the connected object. Small, 38.0 38.0 fieldCount Integer The number of columns in the connected object. Small, 38.0 38.0 fieldsUrl String URL to get the fields associated with the connected object. Small, 37.0 37.0 filterApplied Boolean Indicates if filters have been applied to this connected object or not. Small, 38.0 38.0 incrementalOn Boolean Indicates if this connected object is incrementally synced or not. Small, 38.0 38.0-45.0 lastRefreshedDate Date The date when this connected object was last synced. Small, 38.0 38.0 passThroughFilter String The pass through filter string for this connected object. Small, 38.0 38.0 replicationDataflowId String The data sync job ID used to populate this connected object. Small, 41.0 41.0 rowLevelSharing String Inherit row level sharing rules for this connected object. Small, 44.0 44.0 sourceObjectName String The name of the source object to sync. Small, 37.0 37.0 status ReplicatedDataflowStatusEnum The status of the connected object. Valid values are: - Cancelled
- Checkpoint
- Dequeued
- Enqueued
- Failure
- Initiated
- New
- Serviced
- Stale
- Success
- Warnings
Small, 38.0 38.0 supportedConnectionModes ConnectWaveConnectionModeEnum[] List of supported connection modes for this dataset. Valid values are: - Full
- Incremental
- PeriodicFull
Small, 46.0 46.0