Analytics REST API Developer Guide
jNewer Version Available
Template Resource
- Resource URL
-
1/wave/templates/<templateIdOrApiName> - Formats
- JSON
- Available Version
- 36.0
- HTTP Methods
- DELETE GET PUT
- GET Request Parameters
- 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–41.0 assetVersion Double The 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 customAttributes TemplateCustomAttributesRepresentation The custom attribute definitions of the template. Big, 44.0 44.0 description String The description of the template. Big, 36.0 36.0 folderSource AssetReferenceRepresentation The folder source of the template Medium, 39.0 39.0 icons TemplateIconsRepresentation The icons configured for the template. Small, 41.0 41.0 id String The ID or fully qualified API name of the 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 template. Medium, 36.0 36.0 namespace String The namespace of the template provider. Medium, 36.0 36.0 releaseInfo TemplateReleaseRepresentation The release information for the template Medium, 37.0 37.0 tags String[] A list of tag definitions for the template. Big, 44.0 44.0 templateIcon String The icon that best represents the Analytics application template. Small, 36.0 36.0–41.0 templateType ConnectWaveTemplateTypeEnum The template type. Valid values are: - App
- Dashboard
- Embedded
- Lens
Small, 36.0 36.0 url String The URL to the detail of the template. Small, 36.0 36.0 videos VideoInfoRepresentation The videos associated with the template. Big, 46.0 46.0 - PUT Request Body (TemplateInputRepresentation)
-
TemplateInputRepresentation inherits properties from the abstract BaseAssetInputRepresentation. These base properties appear in TemplateInputRepresentation alongside the properties defined explicitly in the following table.
Property Name Type Description Required or Optional Available Version dataflow AssetReferenceInputRepresentation The dataflow associated with this app. Optional 39.0 folderSource AssetReferenceInputRepresentation The folder from which this template is created from. Required 39.0 - PUT 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–41.0 assetVersion Double The 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 customAttributes TemplateCustomAttributesRepresentation The custom attribute definitions of the template. Big, 44.0 44.0 description String The description of the template. Big, 36.0 36.0 folderSource AssetReferenceRepresentation The folder source of the template Medium, 39.0 39.0 icons TemplateIconsRepresentation The icons configured for the template. Small, 41.0 41.0 id String The ID or fully qualified API name of the 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 template. Medium, 36.0 36.0 namespace String The namespace of the template provider. Medium, 36.0 36.0 releaseInfo TemplateReleaseRepresentation The release information for the template Medium, 37.0 37.0 tags String[] A list of tag definitions for the template. Big, 44.0 44.0 templateIcon String The icon that best represents the Analytics application template. Small, 36.0 36.0–41.0 templateType ConnectWaveTemplateTypeEnum The template type. Valid values are: - App
- Dashboard
- Embedded
- Lens
Small, 36.0 36.0 url String The URL to the detail of the template. Small, 36.0 36.0 videos VideoInfoRepresentation The videos associated with the template. Big, 46.0 46.0 - TemplateIconsRepresentation
-
Property Name Type Description Filter Group and Version Available Version appBadge AssetReferenceRepresentation The badge icon used on any app created from this template. Small, 41.0 41.0 templateBadge AssetReferenceRepresentation The badge icon used to represent this template in the template configuration wizard. Small, 41.0 41.0 templatePreviews ImageAssetReferenceRepresentation[] The list of images to display in the carousel on the template detail page when the template is selected in the wizard. Small, 44.0 44.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 - TemplateCustomAttributesRepresentation
-
Property Name Type Description Filter Group and Version Available Version label String The label for the custom attribute metadata. Small, 44.0 44.0 values String[] The list of values for the custom attribute metadata. Small, 44.0 44.0 - VideoInfoRepresentation
-
Property Name Type Description Filter Group and Version Available Version id String The platform-specific ID of the video content. Small, 46.0 46.0 label String The title of the video. Small, 46.0 46.0 linkType ConnectTemplateVideoLinkTypeEnum The video platform. Valid values are: - Vidyard
- YouTube
Small, 46.0 46.0 purpose ConnectTemplateVideoPurposeEnum The video purpose. Valid values are: - Onboarding
- Walkthrough
Small, 46.0 46.0 showPlaylist Boolean Indicates whether the video platform displays a playlist or not. Small, 46.0 46.0 - ImageAssetReferenceRepresentation
-
ImageAssetReferenceRepresentation inherits properties from the abstract BaseAssetInputRepresentation. These base properties appear in ImageAssetReferenceRepresentation alongside the properties defined explicitly in the following table.
Property Name Type Description Filter Group and Version Available Version description String The image description. Small, 44.0 44.0