Templates Configuration Resource | Analytics REST API Developer Guide

1/wave/templates/<templateIdOrApiName>/configuration

JSON

36.0

GET

Parameter Name	Type	Description	Required or Optional	Available Version
`disableApex`	Bool	Disables any apex integration hooks if true. Default is false.	Optional	36.0

TemplateConfigurationRepresentation

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

UiDefinitionRepresentation

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

PageRepresentation

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 (such as {{Variables.selectedOption}}).	Small, 36.0	36.0
`helpUrl`	String	A 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`	PageVariableRepresentation[]	The collection of variables for this template configuration.	Small, 36.0	36.0
`vfPage`	AssetReferenceRepresentation	The Visualforce page to be used as the user interface instead of the standard wizard interface.	Small, 40.0	40.0

PageVariableRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`name`	String	The name of a variable.	Small, 36.0	36.0
`visibility`	String	The visibility expression for this variable	Small, 36.0	36.0

Wave Variable Definition

VariableDefinitionRepresentation

Property Name	Type	Description	Filter Group and Version	Available Version
`computedValue`	Object	The computed value of the variable. This value is set by integrated apex implementations.	Small, 38.0	38.0
`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[]	List of values to exclude from the variable selection.	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`	VariableTypeRepresentation	The type of the variable.	Small, 36.0	36.0

Property Name	Type	Description	Filter Group and Version	Available Version
`type`	VariableTypeEnum	The type of the variable: ArraytType: The variable type is an array of objects. BooleanType: The variable type is of type boolean (true, false). DatasetDateType: The variable type is date within a dataset. DatasetDimensionType: The variable type is dimension within a dataset. DatasetMeasureType: The variable type is measure within a dataset. DatasetType: The variable type is dataset type that references a dataset within your organization. DateTimeType: The variable type is of type date/time. NumberType: Restricts user input to values of numeric type. ObjectType: The variable type is an arbitrary object. SobjectFieldType: The variable type is sObject-field, or references a field within an sObject. See also sObject variable type. SobjectType: The variable type is of type sObject, or should reference an sObject within your organization. StringType: The variable type is of type string	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}