getWaveTemplateConfig

Retrieves the configuration for a CRM Analytics template.

Syntax 

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

CRM Analytics API Resource 

1GET /wave/templates/${templateIdOrApiName}/configuration

getWaveTemplateConfig uses this CRM Analytics API resource.

Parameters 

Parameter NameTypeDescriptionRequired?
templateIdOrApiNameStringThe ID or developer name of the template.Yes
disableApexBooleanIndicates whether Apex integration hooks are disabled (true) or not (false).
optionsStringFilters the configuration by template visibility options.
  • CreateApp
  • ManageableOnly
  • OrgCanViewOnly
  • ViewOnly

Returns