Wave REST API Developer Guide

Working with the Wave REST API
Wave REST API Reference
Wave REST API Resources Overview
Wave Resource
Query Resource
Datasets List Resource
Dataset Resource
Versions List Resource
Version Resource
File Resource
XMD List Resource
XMD Resource
Lenses List Resource
Lens Resource
Lens File Resource
Lens File Metadata Resource
Dashboards List Resource
Dashboard Resource
Dependencies Resource
Features Configuration Resource
Folders List Resource
Folder Resource
Templates List Resource
Templates Resource
Templates Configuration Resource
Annotations List Resource
Annotation Resource
Template Release Notes Resource
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Folders List Resource

Creates a Wave Analytics application (POST), which is a folder that contains Wave datasets, lenses, and dashboards, or returns a collection of applications or folders (GET).
Resource URL
1/wave/folders
Formats
JSON
Available Version
36.0
HTTP Methods
GET and POST
GET Request Parameters
Parameter Name Type Description Required or Optional Available Version
page String A generated token that indicates the view of the folders to be returned. Optional 36.0
pageSize Int Number of items to be returned in a single page. Minimum is 1, maximum is 200, and default is 25. Optional 36.0
q String Search terms. Individual terms are separated by spaces. Wild cards aren’t supported. Optional 36.0
sort String Sort order of the results. Values are:
  • LastModified
  • Mru: Most recently used (last viewed date)
  • Name

The default is Mru.

 Optional 36.0
GET Response Body
Property Name Type Description Filter Group and Version Available Version
folders Wave Folder[] A list of folders or applications. Small, 36.0 36.0
nextPageUrl String The URL for the next page of content in the collection. Small, 36.0 36.0
totalSize Integer The total count of the elements in the collection. Medium, 36.0 36.0
url String The URL for the collection. Small, 36.0 36.0
POST 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. Required 36.0
name String The API name of the new folder or application. Required 36.0
shares List The rules for sharing the new folder or application. Optional 36.0
templateSourceId String The source template ID or API name used to create the folder or application. Optional 36.0
templateValues Map The runtime template values to use during creation of the folder or application, as specified by the individual application template. Optional 36.0
POST Response Body
Wave Folder