getWaveTemplate

Retrieves a CRM Analytics template.

Syntax 

1import { LightningElement, wire } from "lwc";
2import { getWaveTemplate } from "lightning/analyticsWaveApi";
3
4export default class GetWaveTemplate extends LightningElement {
5  @api templateID; // or fetch the ID
6  @wire(getWaveTemplate, {
7    templateIdOrApiName: "$templateId",
8  })
9  onGetWaveTemplate({ data, error }) {
10    if (error) {
11      console.log("getWaveTemplate(${templateId}) ERROR:", error);
12    } else if (data) {
13      console.log("getWaveTemplate(${templateId}) RESPONSE:", data);
14    }
15  }
16}

CRM Analytics API Resource 

1GET /wave/templates/${templateIdOrApiName}

getWaveTemplate uses this CRM Analytics API resource.

Parameters 

Parameter NameTypeDescriptionRequired?
templateIdOrApiNameStringThe ID or developer name of the template.Yes
optionsStringTemplate visibility options to apply to the collection results.
  • CreateApp
  • ManageableOnly
  • ViewOnly

Returns