Folder Resource

Returns, deletes, updates, or replaces an Analytics app or folder with the specified ID.

Resource URL

1/wave/folders/<folderID>

Formats

JSON

Available Version

36.0

Available in Postman

To view and test a working example of this resource, see getWaveFolder in Postman. For information about how to authenticate your org with Postman, see the CRM Analytics Rest API Quick Start.

Available Components

Aura — <wave:sdk> updateFolder()
Aura — <wave:sdk> upgradeFolder()
Aura — <wave:sdk> deleteFolder()
LWC — lightning/analyticsWaveApi getWaveFolder()
LWC — lightning/analyticsWaveApi deleteWaveFolder()
LWC — lightning/analyticsWaveApi updatePartialWaveFolder()
LWC — lightning/analyticsWaveApi updateWaveFolder()

HTTP Methods

GET DELETE PATCH PUT

GET Request Parameters

Parameter Name	Type	Description	Required or Optional	Available Version
`disableMru`	Boolean	Indicates whether to update the MRU should be updated (`true`) or not (`false`).	Optional	53.0
`mobileOnlyFeaturedAssets`	Boolean	Indicates whether to filter the collection of folders to show only dashboards that are enabled for the Analytics mobile app (`true`) or not (`false`) .	Optional	43.0

To get the application log for the folder, use the filterGroup request parameter with the Supplemental value in the GET request.

1/wave/folders/<folderID>?filterGroup=Supplemental

Response body for GET

Wave Folder

Request body for PUT and PATCH

This can be a Wave Folder Input or a Wave Folder Template Input, both of which implement the Base Wave Folder Input.

Response body for PATCH and PUT