Analytics REST API Developer Guide

Working with the Analytics REST API
Analytics REST API Reference
Analytics REST API Resources Overview
Wave Resource
Auto-Install Requests List Resource
Auto-Install Request Resource
Annotations List Resource
Annotation Resource
Charts Geodata List Resource
Charts Geodata Resource
Charts Geodata File List Resource
Charts Maps List Resource
Charts Maps Resource
Dashboards List Resource
Dashboard Resource
Dashboard Bundle Resource
Dashboard Histories Resource
Dashboard Publishers List Resource
Dashboard Publisher Resource
Dashboard Image Resource
Dashboard Saved Views List Resource
Dashboard Saved Views Resource
Dashboard Saved Views Initial Resource
Data Connector Resource
Data Connectors List Resource
Data Connector Ingest Resource
Data Connector Source Objects List Resource
Data Connector Source Object Resource
Data Connector Source Object Data Preview Resource
Data Connector Source Object Fields Resource
Data Connector Status Resource
Data Connector Types Resource
Dataflow Jobs List Resource
Dataflow Job Resource
Dataflow Job Nodes List Resource
Dataflow Job Nodes Resource
Dataflows List Resource
Dataflow Resource
Datasets List Resource
Dataset Resource
Dependencies Resource
Features Configuration Resource
Folders List Resource
Folder Resource
Lenses List Resource
Lens Resource
Lens File Resource
Lens File Metadata Resource
Lens Bundle Resource
Query Resource
Recipes List Resource
Recipe Resource
Recipe File Resource
Recipe Notification Resource
Replicated Dataset Resource
Replicated Datasets List Resource
Replicated Dataset Fields Resource
Schedule Resource
Security Coverage Dataset Version Resource
Security Coverage Object Resource
Templates List Resource
Template Resource
Template Configuration Resource
Template Release Notes Resource
Trended Reports List Resource
Trended Reports Resource
Dataset Versions List Resource
Dataset Version Resource
Dataset Version File Resource
Xmd List Resource
Xmd Resource
Asset Xmd Resource
Additional Analytics REST API Resources
PDF

Newer Version Available

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

Lens File Metadata Resource

Returns or creates the lens file metadata with the specified ID or API name.
Resource URL
Formats
JSON
Available Version
36.0
HTTP Methods
GET POST
GET Request Parameters
Parameter Name Type Description Required or Optional Available Version
page String

A generated token that indicates the view of the lenses to be returned.

 Optional 36.0
pageSize Integer

The number of items to be returned in a single page. Minimum is 1,

maximum is 200, and default is 25.

 Optional 36.0
GET Response Body (WaveFileMetadataCollectionRepresentation)
Property Name Type Description Filter Group and Version Available Version
files Wave​File​Metadata​Representation[] The list of file metadata. Small, 36.0 36.0
next​Page​Url String The URL to get the next page of contents in the collection. Small, 36.0 36.0
total​Size Integer The total count of the elements in the collection irrespective of the page. Medium, 36.0 36.0
url String The URL to get the collection. Small, 36.0 36.0
POST Request Parameters
Parameter Name Type Description Required or Optional Available Version
preview​File Binary The binary upload to create the preview file. Required 36.0
POST Response Body (WaveFileMetadataRepresentation)
Property Name Type Description Filter Group and Version Available Version
created​By Wave​User​Representation The user that created the file. Medium, 36.0 36.0
created​Date Date The created date of the file. Medium, 36.0 36.0
id String The 18 character file ID. Small, 36.0 36.0
last​Accessed​Date Date The last accessed date of the file. Medium, 36.0 36.0
last​Modified​Date Date The last modified date of the file. Medium, 36.0 36.0
length Integer The size of the binary file. Small, 36.0 36.0
name String The name of the file. Small, 36.0 36.0
url String The URL of the file. Small, 36.0 36.0