Dataset Resource | Analytics REST API Developer Guide

1/wave/datasets/<dataset ID>

JSON

36.0

GET, DELETE, and PATCH

DatasetInputRepresentation

Property Name	Type	Description	Required or Optional	Available Version
`currentVersionId`	ID	The 18-character ID of the current version of this dataset. Do not use.	Optional	36.0–40.0
`description`	String	The description of the dataset.	Optional	36.0
`folder`	ID	The 18-character ID of the folder that contains the dataset. For example: `1"folder": { 2 "id":"005xx000001SwTWAA0" 3}` To patch the folder, you must have edit access to the current and new folders.	Optional	36.0
`label`	String	The label of the dataset.	Optional	36.0
`name`	String	The name of the dataset. Patching of developer names for datasets is not allowed. Dataflows reference datasets by using their developer names, and changing names can lead to broken dataflows. Note	Optional	36.0
`userXmd`	XmdInputRepresentation	User XMD associated with this dataset.	Optional	39.0

DatasetRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`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
`currentVersionTotalRows`	Integer	Total number of rows in the dataset.	Supplemental, 42.0	42.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: Default or Trended.	Small, 41.0	41.0
`folder`	AssetReferenceRepresentation	A reference to the folder in which this dataset is stored.	Small, 36.0	36.0
`lastQueriedDate`	Date	The last time this dataset was queried.	Small, 39.0	39.0
`userXmd`	XmdRepresentation	Reference to the associated user XMD (if any).	`userXmd`	XmdRepresentation
`versionsUrl`	String	The URL for dataset versions.	`versionsUrl`	String

BaseWaveAssetRepresentation

DatasetRepresentation inherits properties from this base representation. These properties appear alongside properties defined explicitly for DatasetRepresentation.

Property Name	Type	Description	Filter Group and Version	Available Version
`assetSharingUrl`	String	The URL for opening this asset in the user interface. 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 asset on a desktop client, or mobile if you are on a mobile OS.	Small, 36.0	36.0
`createdBy`	WaveUserRepresentation	The creator of the asset.	Small, 36.0	36.0
`createdDate`	Date	The time at which the asset was created, in ISO8601 date format.	Small, 36.0	36.0
`description`	String	Short description of the asset.	Small, 36.0	36.0
`id`	ID	The 18-character ID of the asset.	Small, 36.0	36.0
`label`	String	The label of the asset.	Small, 36.0	36.0
`lastAccessedDate`	Date	The last time the asset was accessed, in ISO8601 date format.	Small, 36.0	36.0
`lastModifiedBy`	WaveUserRepresentation	The user who last updated the asset.	Small, 36.0	36.0
`lastModifiedDate`	Date	The last time the asset was modified, in ISO8601 date format.	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	The permissions for the current user.	Small, 36.0	36.0
`type`	ConnectWaveAssetTypeEnum	The asset type. Valid types include: Component Dashboard DashboardSnapshot DataConnector DataPoolEntity DataPoolEntityVersion Dataflow DataflowJob Dataset DatasetShard DatasetVersion ExternalData Folder Lens Recipe ReplicatedDataset Story Workflow	Small, 36.0	36.0
`url`	String	The URL to the definition of the asset.	Small, 36.0	36.0

WaveUserRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`id`	ID	The 18-character user ID.	Small, 36.0	36.0
`name`	String	The name of the user.	Small, 36.0	36.0
`profilePhotoUrl`	String	The Chatter profile photo of the user.	Small, 36.0	36.0

PermissionsRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`manage`	Boolean	Indicates whether a user can manage access control on an asset.	Small, 36.0	36.0
`modify`	Boolean	Indicates whether a user can modify an asset.	Small, 36.0	36.0
`view`	Boolean	Indicates whether a user can view an asset.	Small, 36.0	36.0

AssetReferenceRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`id`	String	The 18-character ID of the asset.	Small, 36.0	36.0
`label`	String	The asset label.	Small, 36.0	36.0
`name`	String	The asset developer name.	Small, 36.0	36.0
`namespace`	String	The namespace that qualifies the asset name.	Small, 37.0	37.0
`url`	String	The asset URL.	Small, 36.0	36.0

1{
2    "createdBy" : {
3      "id" : "005D00000018LSoIAM",
4      "name" : "User Name",
5      "profilePhotoUrl" : "https://yourInstance.salesforce.com/profilephoto/005/T"
6    },
7    "createdDate" : "2015-03-25T20:27:34.000Z",
8    "currentVersionId" : "0FcD00000000183KAA",
9    "currentVersionUrl" : "/services/data/v36.0/wave/datasets/0FbD000000000huKAA/versions/0FcD00000000183KAA",
10    "folder": {
11      "id":"005xx000001SwTWAA0"
12    },
13    "id" : "0FbD000000000huKAA",
14    "label" : "OppHistory",
15    "lastAccessedDate" : "2015-03-27T18:31:39.000Z",
16    "lastModifiedBy" : {
17      "id" : "005D00000018LT8IAM",
18      "name" : "Integration User",
19      "profilePhotoUrl" : ""https://yourInstance.salesforce.com/profilephoto/005/U""
20    },
21    "lastModifiedDate" : "2015-03-25T20:27:44.000Z",
22    "name" : "OppHistory",
23    "permissions" : {
24      "modify" : true,
25      "view" : true
26    },
27    "type" : "dataset",
28    "url" : "/services/data/v36.0/wave/datasets/0FbD000000000huKAA"
29  }