Folder Resource | Analytics REST API Developer Guide

1/wave/folders/<folder ID>

JSON

36.0

GET, PUT, PATCH, DELETE

Parameter Name	Type	Description	Required or Optional	Available Version
`mobileOnlyFeaturedAssets`	Bool	Set this parameter to true to show only dashboards that are enabled for the Einstein Analytics mobile app.	Optional	43.0

WaveFolderInputRepresentation

Property Name	Type	Description	Available Version
`applicationStatus`	ConnectWaveApplicationStatusEnum	The creation status of application (CancelledStatus, CompletedStatus, DataflowInProgressStatus, FailedStatus, InProgressStatus, NewStatus).	36.0
`assetIcon`	String	The icon enumeration that best represents the new folder or application. Valid values are 1.png through 20.png.	36.0
`attachedFiles`	AssetReferenceInputRepresentation[]	The attached file ID list	39.0
`canBeSharedExternally`	Boolean	Whether the application is shared in Communities	37.0
`defaultAsset`	AssetReferenceInputRepresentation	The ID of a lens/dashboard which is presented by default for this application in App Runtime.	37.0
`description`	String	The description of the new folder or application.	36.0
`featuredAssets`	Map (FeaturedAssetsInputRepresentation)	The featured assets for this application to be used in the UI.	39.0
`isPinned`	Boolean	Whether the application is a pinned folder.	39.0
`label`	String	The user-facing name of the new folder or application.	36.0
`name`	String	The internal API name of the new folder or application.	36.0
`shares`	WaveFolderShareInputRepresentation[]	The folder sharing rules.	36.0

Property Name	Type	Description	Filter Group and Version	Available Version
`applicationStatus`	ConnectWaveApplicationStatusEnum	The creation status of application (CancelledStatus, CompletedStatus, DataflowInProgressStatus, FailedStatus, InProgressStatus, NewStatus) .	Medium, 36.0	36.0
`attachedFiles`	AssetReferenceRepresentation[]	The id's of the files attached to the insights folder	Big, 39.0	39.0
`canBeSharedExternally`	Boolean	Whether this app can be shared with Community Users.	Big, 37.0	37.0
`defaultAsset`	AssetReferenceRepresentation	The default asset (lens/dashboard) that is presented when the app is viewed in AppRuntime mode.	Big, 37.0	37.0
`featuredAssets`	Map (FeaturedAssetsRepresentation)	The featured assets for this application to be used in the UI.	Big, 39.0	39.0
`icon`	AssetReferenceRepresentation	The asset icon.	Small, 36.0	36.0
`isPinned`	Boolean	Whether this app is pinned/unpinned.	Small, 39.0	39.0
`shares`	WaveFolderShareRepresentation[]	The folder shares list.	Big, 36.0	36.0
`templateOptions`	TemplateOptionsRepresentation	The options used on the last action performed on a templated Analytics application.	Big, 37.0	37.0
`templateSourceId`	String	The source template ID or api name used to create the folder or application.	Medium, 36.0	36.0
`templateValues`	Map (Object)	The template values used to create or update the folder or application (where applicable).	Big, 37.0	37.0
`templateVersion`	String	The version of the template this application was created from.	Medium, 37.0	37.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: `1http://{host}/analytics/application/005xx000001SvSwAAK?urlType=sharing&orgId=00DT0000000Dpvc&loginHost=https%3A%2F%2Ftest.my.salesforce.com` Might produce the following web Url: `1http://{host}/insights/web/explore.apexp#application/005xx000001SvSwAAK` Or it might produce the following Url on iOS: `1com.salesforce.kona://application/005xx000001SvSwAAK&orgId=00DT0000000Dpvc&loginHost=https%3A%2F%2Ftest.my.salesforce.com`	Small, 36.0	36.0
`createdBy`	WaveUserRepresentation	The 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. Values are: Dashboard DataConnector Dataflow Dataset DatasetShard (internal) DatasetVersion ExternalData Folder Lens Recipe ReplicatedDataset Workflow	Small, 36.0	36.0
`url`	String	URL to get the definition of the asset.	Small, 36.0	36.0

FeaturedAssetsRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`assets`	TypedAssetReferenceRepresentation[]	The list of featured assets.	Small, 39.0	39.0

TypedAssetReferenceRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`type`	ConnectWaveAssetTypeEnum	The asset type (Dashboard, DataConnector, DataPoolEntity, DataPoolEntityVersion, Dataflow, DataflowJob, Dataset, DatasetShard, DatasetVersion, ExternalData, Folder, Lens, Recipe, ReplicatedDataset, or Workflow).	Small, 40.0	40.0

WaveFolderShareInputRepresentation

Property Name	Type	Description	Available Version
`accessType`	ConnectWaveAccessTypeEnum	The access type (Edit, Manage, View).	36.0
`shareType`	ConnectWaveShareTypeEnum	The share type (AllCspUsers, AllPrmUsers, CustomerPortalUser, Group, Organization, PartnerUser, PortalRole, PortalRoleAndSubordinates, Role, RoleAndSubordinates, User).	36.0
`sharedWithId`	ID	ID of the entity that the folder is shared with.	36.0

Wave Folder Share

WaveFolderShareRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`accessType`	ConnectWaveAccessTypeEnum	The access type of the user (Edit, Manage, or View).	Small, 36.0	36.0
`imageUrl`	String	The URL of the user image.	Small, 36.0	36.0
`shareType`	ConnectWaveShareTypeEnum	The share type of the user. 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

FeaturedAssetsInputRepresentation

Property Name	Type	Description	Required or Optional	Available Version
`assets`	TypedAssetReferenceInputRepresentation[]	List of default featured assets		39.0

TypedAssetReferenceInputRepresentation

Property Name	Type	Description	Required or Optional	Available Version
`type`	ConnectWaveAssetTypeEnum	The asset type (Dashboard, DataConnector, DataPoolEntity, DataPoolEntityVersion, Dataflow, DataflowJob, Dataset, DatasetShard, DatasetVersion, ExternalData, Folder, Lens, Recipe, ReplicatedDataset, or Workflow).		40.0

Template Options

TemplateOptionsRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`appAction`	ConnectWaveTemplateAppActionEnum	The last template action performed on the templated application (Create or Upgrade).	Medium, 37.0	37.0
`appActionDate`	Date	The date/time the last action was performed.	Medium, 37.0	37.0
`appActionUser`	WaveUserRepresentation	The user that performed the last action.	Medium, 37.0	37.0

1{
2  "applicationStatus" : "newstatus",
3  "assetIcon" : "6.png",
4  "assetIconUrl" : "https://yourInstance.salesforce.com/icons/6.png",
5  "assetSharingUrl" : "https://yourInstance.salesforce.com/application?assetId=xxx&orgId=yyy&loginHost=jsmith-ltm.yourInstance.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}