Analytics REST API Developer Guide
jNewer Version Available
Replicated Datasets Resource
Replicates data from an external Source Object into an Analytics as a dataset.
Replicated Datasets are not intended to be visualized directly, but are used like a cache to
speed up other workflows which refer to the same source object.
- Resource URL
-
1/wave/replicatedDatasets/<ID>Requires the following permissions:- orgHasReplicationEnabled
- ELTEditor
- InsightsAdmin
- Formats
- JSON
- Available Version
- 37.0
- HTTP Methods
- DELETE GET PATCH
- GET Response Body
-
ReplicatedDatasetRepresentation
Property Name Type Description Filter Group and Version Available Version connector DataConnectorRepresentation Internal Use Small, 37.0 37.0 datasetId String Dataset ID that is associated with the source object being replicated Small, 38.0 38.0 fieldCount Integer Indicates column count for the replicated dataset Small, 38.0 38.0 fieldsUrl String Url to get the fields associated with the replicated dataset Small, 37.0 37.0 filterApplied Boolean Indicates if filters have been applied to the replicated dataset Small, 38.0 38.0 incrementalOn Boolean Indicates if Incremental is on for the replicated dataset Small, 38.0 38.0 lastRefreshedDate Date Indicates the date when the dataset was last run Small, 38.0 38.0 passThroughFilter String The replicated objects pass through filter string Small, 38.0 38.0 replicationDataflowId String Dataflow ID that is associated with running individual replication for the object. Small, 41.0 41.0 sourceObjectName String The name of the source object being replicated. Small, 37.0 37.0 status ReplicatedDataflowStatusEnum Current Status of the replicated dataset (Cancelled, Checkpoint, Dequeued, Enqueued, Failure, Initiated, New, Serviced, Stale, Success, Warnings). Small, 38.0 38.0 assetSharingUrl String The URL for opening this asset in the Analytics builder. This is a form of deep linking. The server examines the link parameters, which might include urlType, assetId, orgId, and loginHost, as well as other optional parameters, and translates as necessary to produce the correct result on the target client. For example, it will open the Analytics dashboard on desktop clients, or mobile if you are on a mobile OS. For example, the shared URL: Might produce the following web Url:1http://{host}/analytics/application/005xx000001SvSwAAK?urlType=sharing&orgId=00DT0000000Dpvc&loginHost=https%3A%2F%2Ftest.my.salesforce.comOr it might produce the following Url on iOS:1http://{host}/insights/web/explore.apexp#application/005xx000001SvSwAAK1com.salesforce.kona://application/005xx000001SvSwAAK&orgId=00DT0000000Dpvc&loginHost=https%3A%2F%2Ftest.my.salesforce.comSmall, 36.0 36.0 createdBy WaveUserRepresentation Represents asset creator. Small, 36.0 36.0 createdDate Date Time the asset was created. Small, 36.0 36.0 description String Short description of the asset. Small, 36.0 36.0 id String The 18 character asset ID. Small, 36.0 36.0 label String The label of the asset. Small, 36.0 36.0 lastAccessedDate Date Last time the asset was accessed. Small, 36.0 36.0 lastModifiedBy WaveUserRepresentation The user that last updated the asset. Small, 36.0 36.0 lastModifiedDate Date Last time the asset was modified. Small, 36.0 36.0 name String The name of the asset. Small, 36.0 36.0 namespace String The namespace of the Asset. Small, 36.0 36.0 permissions PermissionsRepresentation Represents permissions for the present user. Small, 36.0 36.0 type ConnectWaveAssetTypeEnum The asset type (Dashboard, Dataconnector, DataPoolEntity, DataPoolEntityVersion, Dataflow, Dataset, DatasetShard, DatasetVersion, ExternalData, Folder, Lens, Recipe, ReplicatedDataset, or Workflow). Small, 36.0 36.0 url String URL to get the definition of the asset. Small, 36.0 36.0 - PATCH Request Body
-
ReplicatedDatasetInputRepresentation
Property Name Type Description Required or Optional Available Version connectorId String Internal use. 39.0 fullRefresh Boolean Whether to perform a full refresh as opposed to incremental. 41.0 passThroughFilter String Passthrough filter for the replicated object 38.0 sourceObjectName String The name of the source object to be replicated. 37.0 - PATCH Response Body
-
ReplicatedDatasetRepresentation
Property Name Type Description Filter Group and Version Available Version connector DataConnectorRepresentation Internal Use Small, 37.0 37.0 datasetId String Dataset ID that is associated with the source object being replicated Small, 38.0 38.0 fieldCount Integer Indicates column count for the replicated dataset Small, 38.0 38.0 fieldsUrl String Url to get the fields associated with the replicated dataset Small, 37.0 37.0 filterApplied Boolean Indicates if filters have been applied to the replicated dataset Small, 38.0 38.0 incrementalOn Boolean Indicates if Incremental is on for the replicated dataset Small, 38.0 38.0 lastRefreshedDate Date Indicates the date when the dataset was last run Small, 38.0 38.0 passThroughFilter String The replicated objects pass through filter string Small, 38.0 38.0 replicationDataflowId String Dataflow ID that is associated with running individual replication for the object. Small, 41.0 41.0 sourceObjectName String The name of the source object being replicated. Small, 37.0 37.0 status ReplicatedDataflowStatusEnum Current Status of the replicated dataset (Cancelled, Checkpoint, Dequeued, Enqueued, Failure, Initiated, New, Serviced, Stale, Success, Warnings). Small, 38.0 38.0 assetSharingUrl String The URL for opening this asset in the Analytics builder. This is a form of deep linking. The server examines the link parameters, which might include urlType, assetId, orgId, and loginHost, as well as other optional parameters, and translates as necessary to produce the correct result on the target client. For example, it will open the Analytics dashboard on desktop clients, or mobile if you are on a mobile OS. For example, the shared URL: Might produce the following web Url:1http://{host}/analytics/application/005xx000001SvSwAAK?urlType=sharing&orgId=00DT0000000Dpvc&loginHost=https%3A%2F%2Ftest.my.salesforce.comOr it might produce the following Url on iOS:1http://{host}/insights/web/explore.apexp#application/005xx000001SvSwAAK1com.salesforce.kona://application/005xx000001SvSwAAK&orgId=00DT0000000Dpvc&loginHost=https%3A%2F%2Ftest.my.salesforce.comSmall, 36.0 36.0 createdBy WaveUserRepresentation Represents asset creator. Small, 36.0 36.0 createdDate Date Time the asset was created. Small, 36.0 36.0 description String Short description of the asset. Small, 36.0 36.0 id String The 18 character asset ID. Small, 36.0 36.0 label String The label of the asset. Small, 36.0 36.0 lastAccessedDate Date Last time the asset was accessed. Small, 36.0 36.0 lastModifiedBy WaveUserRepresentation The user that last updated the asset. Small, 36.0 36.0 lastModifiedDate Date Last time the asset was modified. Small, 36.0 36.0 name String The name of the asset. Small, 36.0 36.0 namespace String The namespace of the Asset. Small, 36.0 36.0 permissions PermissionsRepresentation Represents permissions for the present user. Small, 36.0 36.0 type ConnectWaveAssetTypeEnum The asset type (Dashboard, Dataconnector, DataPoolEntity, DataPoolEntityVersion, Dataflow, Dataset, DatasetShard, DatasetVersion, ExternalData, Folder, Lens, Recipe, ReplicatedDataset, or Workflow). Small, 36.0 36.0 url String URL to get the definition of the asset. Small, 36.0 36.0 - PATCH Request Parameters
-
Parameter Name Type Description Required or Optional Available Version replicatedDataset Object (ReplicatedDatasetInputRepresentation) Replicated Dataset to use to update target. Required 38.0