Templates Configuration Resource | Wave REST API Developer Guide

1/wave/templates/<templateIdOrApiName>/configuration

JSON

36.0

GET

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
`displayMessages`	DisplayMessageRepresentation[]	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
`excludeSelected`	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
`mostRecentValue`	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

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

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

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

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

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

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

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

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

1{
2    "ui": {
3        "pages": [
4            {
5                "title": "Application Preferences",
6                "variables": [
7                    "lensDashboardName",
8                    "dashboardHeader"
9                ]
10            },
11            {
12                "title": "Other preferences",
13                "variables": [
14                    "emailNotifications",
15                    "emailAddress"
16                ]
17            }
18        ]
19    },
20    "variables": {
21        "numberPicked": {
22            "defaultValue": 3,
23            "description": "A number between 1 and 10.",
24            "excludeSelected": false,
25            "excludes": [],
26            "label": "Please pick a number between 1 and 10?",
27            "required": true,
28            "variableType": {
29                "enums": [],
30                "max": 10,
31                "min": 1,
32                "type": "NumberType"
33            }
34        },
35        "lensDashboardName": {
36            "defaultValue": "My View of Election Data",
37            "description": "The name of the sample lens.",
38            "excludeSelected": false,
39            "excludes": [],
40            "label": "What would you like to name your lens and dashboard?",
41            "required": true,
42            "variableType": {
43                "enums": [],
44                "type": "StringType"
45            }
46        },
47        "dashboardHeader": {
48            "defaultValue": "Wow! Interactive Dashboards are Nice!",
49            "description": "The dashboard header.",
50            "excludeSelected": false,
51            "excludes": [],
52            "label": "What would you like the dashboard header to say?",
53            "required": true,
54            "variableType": {
55                "enums": [],
56                "type": "StringType"
57            }
58        },
59        "emailNotifications": {
60            "defaultValue": "Yes",
61            "description": "Email notifications",
62            "excludeSelected": false,
63            "excludes": [],
64            "label": "Would you like to receive emails for promotions?",
65            "required": false,
66            "variableType": {
67                "enums": [
68                    "Yes",
69                    "No"
70                ],
71                "type": "StringType"
72            }
73        },
74        "emailAddress": {
75            "defaultValue": null,
76            "description": "Your email address.",
77            "excludeSelected": false,
78            "excludes": [],
79            "label": "Please enter your email address?",
80            "required": false,
81            "variableType": {
82                "enums": [],
83                "type": "StringType"
84            }
85        }
86    }
87}