Analytics REST API Developer Guide

Working with the Analytics REST API
Analytics REST API Reference
Analytics REST API Resources Overview
Wave 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 Image Resource
Data Connector Resource
Data Connectors List Resource
Data Connector Source Objects List Resource
Data Connector Source Object Resource
Data Connector Source Object Data Resource
Data Connector Source Object Data Preview Resource
Data Connector Source Object Fields Resource
Data Connector Types Resource
Datasets List Resource
Dataset Resource
Dependencies Resource
Features Configuration Resource
File Resource
Folders List Resource
Folder Resource
Lenses List Resource
Lens Resource
Lens File Resource
Lens File Metadata Resource
Query Resource
Recipes List Resource
Recipe Resource
Recipe File Resource
Replicated Datasets Resource
Replicated Datasets List Resource
Replicated Dataset Fields Resource
Templates List Resource
Templates Resource
Templates Configuration Resource
Template Release Notes Resource
Trended Reports List Resource
Trended Reports Resource
Versions List Resource
Version Resource
XMD List Resource
XMD Resource
PDF

Newer Version Available

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

Templates Resource

Adds or returns the representation for an Analytics template.
Resource URL
1/wave/templates/<templateIdOrApiName>
Formats
JSON
Available Version
36.0
HTTP Methods
DELETE GET PUT
GET Response Body

TemplateRepresentation

Property Name Type Description Filter Group and Version Available Version
assetIcon String The icon that best represents the Analytics application. Small, 36.0 36.0
assetVersion Double Asset version (api version) of all the dashboards and lenses. Big, 37.0 37.0
configurationUrl String The URL to the configuration of the template. Small, 36.0 36.0
description String The description of the application template. Big, 36.0 36.0
folderSource Asset​Reference​Representation The folder source of this template Medium, 39.0 39.0
id String The ID or fully qualified API name of this template. Small, 36.0 36.0
label String The localized name of the application template. Small, 36.0 36.0
name String The local API name of the application template. Medium, 36.0 36.0
namespace String The namespace of the application template provider. Medium, 36.0 36.0
releaseInfo Template​Release​Representation The release information for this template Medium, 37.0 37.0
templateIcon String The icon that best represents the Analytics application template. Small, 36.0 36.0
templateType Connect​Wave​Template​Type​Enum The template type, if empty or null then template type is app.
  • App
  • Dashboard
  • Lens
 Small, 36.0 36.0
url String The URL to the detail of the template. Small, 36.0 36.0
PUT Request Body
TemplateInputRepresentation
PUT Response Body
TemplateRepresentation
PUT Request Parameters
Parameter Name Type Description Required or Optional Available Version
templateParam Template​Input​Representation Analytics Template Input Representation 39.0
TemplateReleaseRepresentation
Property Name Type Description Filter Group and Version Available Version
notesUrl String The URL to the release notes for this template Small, 37.0 37.0
templateVersion String The version of this template. Small, 37.0 37.0