Replicated Dataset Resource

Returns, updates, and deletes replicated datasets, also know as connected objects. A data sync loads source object data as a connected object in Analytics. Connected objects can’t be visualized directly, but are used like a cache to speed up other jobs that pull from the source object and load it into a dataset.

Resource URL

1/wave/replicatedDatasets/<id>

Formats

JSON

Available Version

37.0

HTTP Methods

DELETE GET PATCH

GET 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

PATCH 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 update an existing connected object by adding a pass through filter and setting the connection mode to Full.

1{
2  "passThroughFilter": "(FiscalQuarter = 2 OR FiscalQuarter = 3) AND Amount > 1000 AND 
3    Amount <= 20000",
4  "connectionMode": "Full"
5}

PATCH Response Body (ReplicatedDatasetRepresentation)

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

Analytics REST API Developer Guide

Replicated Dataset Resource