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

Templates Configuration Resource

Returns the configuration of a Wave Analytics template.
Resource URL
Formats
JSON
Available Version
36.0
HTTP Methods
GET
GET Response Body
Property Name Type Description Filter Group and Version Available Version
ui Wave UI Definition The user interface definition for the template. Small, 36.0 36.0
variables Map <String, Wave Variable Definition> The defined set of variables for the template. Small, 36.0 36.0
Wave UI Definition
Property Name Type Description Filter Group and Version Available Version
display​Messages Display​Message​Representation[] The display messages for this template configuration. Small, 36.0 36.0
pages Page[] The page collection for this template configuration. Small, 36.0 36.0
DisplayMessageRepresentation
Property Name Type Description Filter Group and Version Available Version
location String The name of the page where the text is to be displayed. Small, 36.0 36.0
text String Text content to display. Small, 36.0 36.0
Page
Property Name Type Description Filter Group and Version Available Version
condition String The optional condition in which the page should be shown. Values should be client-side EL notation (e.g. {{Variables.selectedOption}}). Small, 36.0 36.0
helpUrl String An URL to this page's help webpage. Small, 36.0 36.0
title String The title for the page. Small, 36.0 36.0
variables String[] The collection of variables for the template configuration and their properties; defines the order to display variables on a page. Small, 36.0 36.0
Wave Variable Definition
Property Name Type Description Filter Group and Version Available Version
defaultValue Object The default value of the variable. Small, 36.0 36.0
description String The description of the variable. Small, 36.0 36.0
exclude​Selected Boolean True if the variable has excludeSelected in the template. Otherwise False. Small, 36.0 36.0
excludes String[] Values to exclude from the variable selection list. Small, 36.0 36.0
label String The label for the variable. Small, 36.0 36.0
most​Recent​Value Object The value specified in the most recent app creation process. Small, 36.0 36.0
required Boolean True if this variable is required by the template. Otherwise False Small, 36.0 36.0
variableType String The type of the variable:
  • DatasetType: Restricts user input to objects in your organization that are of type “dataset”.
  • DatasetDateType: Restricts user input to attributes of type “date” within a dataset, which can used for groupings when referenced by dashboard templates.
  • DatasetDimensionType: Restricts user input to attributes of type "dimension" within a dataset,which can used for groupings when referenced by dashboard templates.
  • DatasetMeasureType: Restricts user input to attributes of type "measure" within a dataset,which can used for measure calculations when referenced by dashboard templates.
  • NumberType: Restricts user input to values of numeric type.
  • SobjectType: Restricts user input to standard or custom sObjects within your organization.
  • SobjectFieldType: Restricts user input to fields within a sObject of similar types.
  • StringType: Restricts user input to values of string type.
 Small, 36.0 36.0
Dataset Type
Property Name Type Description Filter Group and Version Available Version
type Object Dataset. Small, 36.0 36.0
datasetID String Id for the dataset. Small, 36.0 36.0
datasetAlias String Alias for the dataset. Small, 36.0 36.0
Dataset Date Type
Property Name Type Description Filter Group and Version Available Version
type Object A dataset date object. Small, 36.0 36.0
datasetID String Id for the dataset. Small, 36.0 36.0
dateAlias String Alias for the dataset date object. Small, 36.0 36.0
Dataset Dimension Type
Property Name Type Description Filter Group and Version Available Version
type Object A dataset dimension object. Small, 36.0 36.0
datasetID String Id for the dataset. Small, 36.0 36.0
fieldName String The name of a dimension field from the dataset. Small, 36.0 36.0
Dataset Measure Type
Property Name Type Description Filter Group and Version Available Version
type Object A dataset measure object. Small, 36.0 36.0
datasetID String Id for the dataset. Small, 36.0 36.0
fieldName String The name of a measure field from the dataset. Small, 36.0 36.0
Number Type
Property Name Type Description Filter Group and Version Available Version
type Type Number. Can optionally be limited by a range of values. Small, 36.0 36.0
enums List The restricted list of enumerated values, where applicable for numeric variable types. Small, 36.0 36.0
max Double The maximum allowed value of the number. (Optional.) Small, 36.0 36.0
min Double The minimum allowed value of the number. (Optional.) Small, 36.0 36.0
sObject Type
Property Name Type Description Filter Group and Version Available Version
type Object sObject. Small, 36.0 36.0
sobjectName String Name of the sObject. Small, 36.0 36.0
sObject Field Type
Property Name Type Description Filter Group and Version Available Version
type Object sObject field. Small, 36.0 36.0
sobjectName String Name of the sObject. Small, 36.0 36.0
fieldName String Name of the sObject field. Small, 36.0 36.0
String Type
Property Name Type Description Filter Group and Version Available Version
type Type String. Small, 36.0 36.0
enums List. The restricted list of enumerated values, where applicable for string variable types. Small, 36.0 36.0
Example Response Body