Tableau CRM REST API Developer Guide
jNewer Version Available
Dataset Resource
- Resource URL
-
1/wave/datasets/<datasetIdOrApiName> - Formats
- JSON
- Available Version
- 36.0
- Available Components
- HTTP Methods
- GET DELETE PATCH
- GET Response Body (DatasetRepresentation)
-
DatasetRepresentation inherits properties from the abstract BaseWaveAssetRepresentation. These base properties appear in DatasetRepresentation alongside the properties defined explicitly in the following table.
Property Name Type Description Filter Group and Version Available Version clientShardsUrl String The URL for the dataset shards. Small, 36.0 36.0 currentVersionCreatedBy WaveUserRepresentation The creator of the current version of the dataset. Only returned if the filterGroup input parameter is set to Supplemental. Supplemental, 36.0 36.0 currentVersionCreatedDate Date The time at which the current version of the dataset was created, in ISO8601 date format. Only returned if the filterGroup input parameter is set to Supplemental. Supplemental, 36.0 36.0 currentVersionId ID The 18-character ID of the current dataset version. Small, 36.0 36.0 currentVersionLastModifiedBy WaveUserRepresentation The user who last updated the current version of the dataset. Only returned if the filterGroup input parameter is set to Supplemental. Supplemental, 36.0 36.0 currentVersionLastModifiedDate Date The last time the current version of the dataset was modified, in ISO8601 date format. Only returned if the filterGroup input parameter is set to Supplemental. Supplemental, 36.0 36.0 currentVersionSupportsNewDates Boolean Indicates whether the current dataset version supports new date formats (true) or not (false). Supplemental, 52.0 52.0 currentVersionTotalRows Integer The total number of rows in the dataset. Supplemental, 42.0 42.0-52.0 currentVersionTotalRowCount Integer The total number of rows in the dataset. Small, 53.0 53.0 currentVersionUrl String The URL for the current dataset version. Small, 36.0 36.0 dataRefreshDate Date The last time this dataset was updated. Small, 40.0 40.0 datasetType ConnectWaveDatasetTypeEnum The type of the dataset. Valid values are: - Default
- Live
- StagedData
- Trended
Small, 41.0 41.0 folder AssetReferenceRepresentation The reference to the folder in which this dataset is stored. Small, 36.0 36.0 lastMetadataChangedDate Date The last time the metadata (folder, label, current, sharing, or security predicate) of this dataset was changed. Small, 51.0 51.0 lastQueriedDate Date The last time this dataset was queried. Small, 39.0 39.0 licenseAttributes LicenseAttributesRepresentation The Analytics license attributes associated with this dataset. Small, 52.0 52.0 liveConnection LiveConnectionRepresentation The live connection details for the dataset. Small, 50.0 50.0 userXmd XmdRepresentation The associated user XMD. Medium, 36.0 36.0 versionsUrl String The URL for dataset versions. Small, 36.0 36.0 visibility ConnectWaveAssetVisibilityType Indicates whether the asset is hidden from users with view access or not. Valid values are: - All (Show all assets)
- Limited (Hide assets from viewers with view access)
Small, 51.0 51.0 - PATCH Request Body (DatasetInputRepresentation)
-
DatasetInputRepresentation inherits properties from the abstract BaseAssetInputRepresentation. These base properties appear in DatasetInputRepresentation alongside the properties defined explicitly in the following table.
Property Name Type Description Required or Optional Available Version currentVersionId ID DEPRECATED The 18-character ID of the current version of this dataset. Optional 36.0–40.0 datasetType ConnectWaveDatasetTypeEnum The type of the dataset. Valid values are: - Default
- Live
- StagedData
- Trended
Required 50.0 folder ID The 18-character ID of the folder that contains the dataset. Optional 36.0 liveConnection LiveConnectionInputRepresentation The live connection details for the dataset. Optional 50.0 userXmd XmdInputRepresentation The user XMD associated with this dataset. Optional 39.0 visibility ConnectWaveAssetVisibilityType Indicates whether the asset is hidden from users with view access or not. Valid values are: - All (Show all assets)
- Limited (Hide assets from viewers with view access)
Optional 51.0 The following JSON shows how to edit an existing dataset description.
1{ 2 "description": "This is my dataset", 3 "label": "Test Dataset" 4} - PATCH Response Body (DatasetRepresentation)
-
DatasetRepresentation inherits properties from the abstract BaseWaveAssetRepresentation. These base properties appear in DatasetRepresentation alongside the properties defined explicitly in the following table.
Property Name Type Description Filter Group and Version Available Version clientShardsUrl String The URL for the dataset shards. Small, 36.0 36.0 currentVersionCreatedBy WaveUserRepresentation The creator of the current version of the dataset. Only returned if the filterGroup input parameter is set to Supplemental. Supplemental, 36.0 36.0 currentVersionCreatedDate Date The time at which the current version of the dataset was created, in ISO8601 date format. Only returned if the filterGroup input parameter is set to Supplemental. Supplemental, 36.0 36.0 currentVersionId ID The 18-character ID of the current dataset version. Small, 36.0 36.0 currentVersionLastModifiedBy WaveUserRepresentation The user who last updated the current version of the dataset. Only returned if the filterGroup input parameter is set to Supplemental. Supplemental, 36.0 36.0 currentVersionLastModifiedDate Date The last time the current version of the dataset was modified, in ISO8601 date format. Only returned if the filterGroup input parameter is set to Supplemental. Supplemental, 36.0 36.0 currentVersionSupportsNewDates Boolean Indicates whether the current dataset version supports new date formats (true) or not (false). Supplemental, 52.0 52.0 currentVersionTotalRows Integer The total number of rows in the dataset. Supplemental, 42.0 42.0-52.0 currentVersionTotalRowCount Integer The total number of rows in the dataset. Small, 53.0 53.0 currentVersionUrl String The URL for the current dataset version. Small, 36.0 36.0 dataRefreshDate Date The last time this dataset was updated. Small, 40.0 40.0 datasetType ConnectWaveDatasetTypeEnum The type of the dataset. Valid values are: - Default
- Live
- StagedData
- Trended
Small, 41.0 41.0 folder AssetReferenceRepresentation The reference to the folder in which this dataset is stored. Small, 36.0 36.0 lastMetadataChangedDate Date The last time the metadata (folder, label, current, sharing, or security predicate) of this dataset was changed. Small, 51.0 51.0 lastQueriedDate Date The last time this dataset was queried. Small, 39.0 39.0 licenseAttributes LicenseAttributesRepresentation The Analytics license attributes associated with this dataset. Small, 52.0 52.0 liveConnection LiveConnectionRepresentation The live connection details for the dataset. Small, 50.0 50.0 userXmd XmdRepresentation The associated user XMD. Medium, 36.0 36.0 versionsUrl String The URL for dataset versions. Small, 36.0 36.0 visibility ConnectWaveAssetVisibilityType Indicates whether the asset is hidden from users with view access or not. Valid values are: - All (Show all assets)
- Limited (Hide assets from viewers with view access)
Small, 51.0 51.0 - LiveConnectionRepresentation
-
Property Name Type Description Filter Group and Version Available Version connectionLabel String The label of the live connection. Small, 50.0 50.0 connectionName String The developer name of the live connection. Small, 50.0 50.0 connectionType ConnectWaveDataConnectorTypeEnum The type of Tableau CRM connector. The list of valid values can be found here. Small, 53.0 53.0 sourceObjectName String The source object name for the live connection. Small, 50.0 50.0 - LiveConnectionInputRepresentation
-
Property Name Type Description Required or Optional Available Version connectionName String The developer name of the live connection. Required 50.0 sourceObjectName String The source object name for the live connection. Required 50.0