Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Template Configuration Resource

Returns the configuration of an Analytics template.

Resource URL

1/wave/templates/<templateIdOrApiName>/configuration

Formats

JSON

Available Components

Apex — Wave.Templates.getTemplateConfig()
Aura — <wave:sdk> getTemplateConfig()
LWC — lightning/analyticsWaveApi getWaveTemplateConfig()

Available Version

36.0

Available in Postman

To view and test a working example of this resource, see getWaveTemplateConfig in Postman. For information about how to authenticate your org with Postman, see the CRM Analytics Rest API Quick Start.

HTTP Methods

GET

Request Parameters for GET

Parameter Name	Type	Description	Required or Optional	Available Version
`disableApex`	Boolean	Indicates whether apex integration hooks are disabled (`true`) or not (`false`).	Optional	36.0
`options`	ConnectWaveTemplateVisibilityOptionsEnum	Filter the template configuration by specifying a visibility option. Valid values are: `CreateApp` `ManageableOnly` `OrgCanViewOnly` `ViewOnly`	Optional	57.0
`templateIdOrApiName`	String	The ID of template to retrieve or delete the lint value for.	Required	36.0

Response body for GET

Template Configuration

CRM Analytics REST API Developer Guide