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
PDF

Newer Version Available

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

Lens File Metadata Resource

Resource for management of Wave lens file metadata.
Resource URL
1/wave/lenses/<lensId>/files
Formats
JSON
Available Version
36.0
HTTP Methods
GET POST
GET Request Parameters
Parameter Name Type Description Required or Optional Available Version
page String 36.0
pageSize Int 36.0
GET Response Body
Get a collection of Wave lens file metadata.
WaveFileMetadataCollectionRepresentation
Property Name Type Description Filter Group and Version Available Version
files Wave​File​Metadata​Representation[] List of file metadata. Small, 36.0 36.0
nextPageUrl String URL to get the next page of contents in the collection. Small, 36.0 36.0
totalSize Integer Gets the total count of the elements in the collection irrespective of the page. Medium, 36.0 36.0
url String URL to get the collection. Small, 36.0 36.0
WaveFileMetadataRepresentation
Property Name Type Description Filter Group and Version Available Version
createdBy Wave​User​Representation created by user Medium, 36.0 36.0
createdDate Date created date Medium, 36.0 36.0
id String The 18 character lens file ID. Small, 36.0 36.0
last​Accessed​Date Date last accessed date Medium, 36.0 36.0
last​Modified​Date Date last modified date Medium, 36.0 36.0
length Integer size of the lens file Small, 36.0 36.0
name String name of lens file Small, 36.0 36.0
url String url of file. Small, 36.0 36.0
WaveUserRepresentation
Property Name Type Description Filter Group and Version Available Version
id String The 18 character user ID. Small, 36.0 36.0
name String The name of the user. Small, 36.0 36.0
profile​Photo​Url String The Chatter profile photo of the user. Small, 36.0 36.0
POST Request Parameters
Parameter Name Type Description Required or Optional Available Version
previewFile Binary 36.0
POST Response Body
Creates lens file.
WaveFileMetadataRepresentation
Property Name Type Description Filter Group and Version Available Version
createdBy Wave​User​Representation created by user Medium, 36.0 36.0
createdDate Date created date Medium, 36.0 36.0
id String The 18 character lens file ID. Small, 36.0 36.0
last​Accessed​Date Date last accessed date Medium, 36.0 36.0
last​Modified​Date Date last modified date Medium, 36.0 36.0
length Integer size of the lens file Small, 36.0 36.0
name String name of lens file Small, 36.0 36.0
url String url of file. Small, 36.0 36.0