Folder Resource

Returns the representation for a Wave Analytics application or folder (GET), replaces an application or folder (PUT), updates it (PATCH), or deletes it (DELETE).

Resource URL

1/wave/folders/<folder ID>

Formats

JSON

Available Version

36.0

HTTP Methods

GET, PUT, PATCH, DELETE

PUT and PATCH Request Body

Property Name	Type	Description	Required or Optional	Available Version
`assetIcon`	String	The file name of the icon that represents the new folder or application. Valid values are `1.png` through `20.png.`	Optional	36.0
`description`	String	The description of the new folder or application.	Optional	36.0
`label`	String	The display name of the new folder or application.	PUT: Required PATCH: Optional	36.0
`name`	String	The API name of the new folder or application.	PUT: Required PATCH: Optional	36.0
`shares`	List	The rules for sharing the new folder or application.	Optional	36.0

GET, PUT, and PATCH Response Body (and /wave/folders POST Response Body)

Property Name	Type	Description	Filter Group and Version	Available Version
`applicationStatus`	String	The status of the application while it’s being created. One of the following: CancelledStatus CompletedStatus DataflowInProgressStatus FailedStatus InProgressStatus NewStatus	Medium, 36.0	36.0
`assetSharingUrl`	String	The sharing URL for the asset.	Small, 36.0	36.0
`createdBy`	Wave User	The user who created the asset.	Small, 36.0	36.0
`createdDate`	Date	The time the asset was created.	Small, 36.0	36.0
`description`	String	The description of the asset.	Small, 36.0	36.0
`icon`	AssetReferenceRepresentation	The icon for the asset.	Small, 36.0	36.0
`id`	String	The 18-character ID of the folder associated with the application.	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.	Small, 36.0	36.0
`lastModifiedBy`	Wave User	The user who last updated the asset.	Small, 36.0	36.0
`lastModifiedDate`	String	The 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`	Permissions	The permissions for the current user.	Small, 36.0	36.0
`shares`	Wave Folder Share[]	The folder shares list.	Big, 36.0	36.0
`templateSourceId`	String	The source template ID or api name used to create the folder or application.	Medium, 36.0	36.0
`type`	String	The asset type. For folders, the value is `folder`.	Small, 36.0	36.0
`url`	String	The URL to get the definition of the asset.	Small, 36.0	36.0

Wave Folder Share

Property Name	Type	Description	Filter Group and Version	Available Version
`accessType`	String	The access type of the user. Values are: `Edit` `Manage` `View`	Small, 36.0	36.0
`imageUrl`	String	The URL of the user image.	Small, 36.0	36.0
`shareType`	String	The share type of the user. Values are: `AllCspUsers` `AllPrmUsers` `CustomerPortalUser` `Group` `Organization` `PartnerUser` `PortalRole` `PortalRoleAndSubordinates` `Role` `RoleAndSubordinates` `User`	Small, 36.0	36.0
`sharedWithId`	String	The ID of the user with the share representation.	Small, 36.0	36.0
`sharedWithLabel`	String	The label for the share user/group/org.	Small, 36.0	36.0

Example Response Body

1{
2  "applicationStatus" : "newstatus",
3  "assetIcon" : "6.png",
4  "assetIconUrl" : "https://na1.salesforce.com/icons/6.png",
5  "assetSharingUrl" : "https://na1.salesforce.com/application?assetId=xxx&orgId=yyy&loginHost=jsmith-ltm.na1.salesforce.com&urlType=sharing",
6  "createdBy" : {
7    "id" : "005xx000001SxwEAAS",
8    "name" : "Admin User",
9    "profilePhotoUrl" : "/profilephoto/005/T"
10  },
11  "createdDate" : "2015-06-22T17:38:33.000Z",
12  "description" : "descr",
13  "icon" : {
14    "alias" : "6.png",
15    "id" : "02Ixx00000003qvEAA",
16    "url" : "/app/icons/6.png"
17  },
18  "id" : "02Ixx00000003qvEAA",
19  "label" : "A new App",
20  "lastModifiedBy" : {
21    "id" : "005xx000001SxwEAAS",
22    "name" : "Admin User",
23    "profilePhotoUrl" : "/profilephoto/005/T"
24  },
25  "lastModifiedDate" : "2015-06-22T17:38:33.000Z",
26  "name" : "A_new_App1",
27  "permissions" : {
28    "manage" : true,
29    "modify" : true,
30    "view" : true
31  },
32  "shares" : [ {
33    "accessType" : "manage",
34    "imageUrl" : "/profilephoto/00G/T",
35    "shareType" : "organization",
36    "sharedWithId" : "00Gxx000000nCDzEAM",
37    "sharedWithLabel" : "All Internal Users"
38  }, {
39    "accessType" : "manage",
40    "imageUrl" : "/profilephoto/005/T",
41    "shareType" : "user",
42    "sharedWithId" : "005xx000001SxzaAAC",
43    "sharedWithLabel" : "Integration User"
44  } ],
45  "type" : "folder",
46  "url" : "/services/data/v36.0/wave/folders/00lxx000000fmEpAAI"
47}

Wave REST API Developer Guide

Folder Resource