Dataset Resource

Returns the Wave Analytics dataset with the specified ID, deletes a dataset (DELETE), or updates a dataset (PATCH).

Resource URL

1/wave/datasets/<dataset ID>

Formats

JSON

Available Version

36.0

HTTP Methods

GET, DELETE, and PATCH

PATCH Request Body

Property Name	Type	Description	Required or Optional	Available Version
`currentVersionId`	ID	The 18-character ID of the current version of this dataset.	Optional	36.0
`description`	String	The description of the dataset.	Optional	36.0
`folder`	ID	The 18-character ID of the folder that contains the dataset. 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

GET and PATCH Response Body

Property Name	Type	Description	Filter Group and Version	Available Version
`assetSharingUrl`	String	Sharing URL for the asset.	Small, 36.0	36.0
`createdBy`	Wave User	The creator of the dataset.	Small, 36.0	36.0
`createdDate`	Date	The time at which the dataset was created, in ISO8601 date format.	Small, 36.0	36.0
`currentVersionCreatedBy`	Wave User	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`	Wave User	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
`currentVersionUrl`	String	The URL for the current dataset version.	Small, 36.0	36.0
`description`	String	Short description of the asset.	Small, 36.0	36.0
`folder`	AssetReferenceRepresentation	A reference to the folder in which this dataset is stored.	Small, 36.0	36.0
`id`	ID	The 18-character ID of the dataset.	Small, 36.0	36.0
`label`	String	The label of the dataset.	Small, 36.0	36.0
`lastAccessedDate`	Date	The last time the dataset was accessed, in ISO8601 date format.	Small, 36.0	36.0
`lastModifiedBy`	Wave User	The user who last updated the dataset.	Small, 36.0	36.0
`lastModifiedDate`	Date	The last time the dataset was modified, in ISO8601 date format.	Small, 36.0	36.0
`name`	String	The dataset name.	Small, 36.0	36.0
`namespace`	String	The namespace of the Asset.	Small, 36.0	36.0
`permissions`	Permissions	The permissions for the current user.	Small, 36.0	36.0
`type`	String	The asset type. For datasets, the value is `dataset`.	Small, 36.0	36.0
`url`	String	The URL to the resource for the dataset.	Small, 36.0	36.0
`versionsUrl`	String	The URL for dataset versions.	Small, 36.0	36.0

Wave User

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

Permissions

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

Example Response Body

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    "folderId" : "005D00000018LSoIAM",
11    "id" : "0FbD000000000huKAA",
12    "label" : "OppHistory",
13    "lastAccessedDate" : "2015-03-27T18:31:39.000Z",
14    "lastModifiedBy" : {
15      "id" : "005D00000018LT8IAM",
16      "name" : "Integration User",
17      "profilePhotoUrl" : ""https://yourInstance.salesforce.com/profilephoto/005/U""
18    },
19    "lastModifiedDate" : "2015-03-25T20:27:44.000Z",
20    "name" : "OppHistory",
21    "permissions" : {
22      "modify" : true,
23      "view" : true
24    },
25    "type" : "dataset",
26    "url" : "/services/data/v36.0/wave/datasets/0FbD000000000huKAA"
27  }

Wave REST API Developer Guide

Dataset Resource