`createDatasetVersion`

Creates a version of a CRM Analytics dataset.

Syntax

1import { createDatasetVersion } from 'lightning/analyticsWaveApi';
2createDatasetVersion( DATASETVERSION : RestoreDatasetVersionInput ): Promise<RestoreDataset>

CRM Analytics API Resource

1POST /wave/datasets/${datasetIdOrApiName}/versions

createDatasetVersion uses this CRM Analytics API resource.

Parameters

Parameter Name	Type	Description	Required?
`datasetVersion`	Object	The dataset version to create. Use a Restore Dataset Version Input resource.

Returns

A Promise object that resolves with the Restore Dataset Version response.

Usage

Use createDatasetVersion to create a version of a CRM Analytics dataset. For example, create a version of the Accounts dataset with updated data.

This example adds a create button to a page. The page must contain form elements for the information required to create the dataset version, like the dataset ID. Creating a dataset version displays a toast message using the lightning/platformShowToastEvent module.

1import { LightningElement, api } from "lwc";
2import { createDatasetVersion } from "lightning/analyticsWaveApi";
3import { ShowToastEvent } from "lightning/platformShowToastEvent";
4
5export default class CreateDatasetVersion extends LightningElement {
6  datasetVersion = {
7    datasetIdOrApiName: "0Fbxx000000xxxxxx",
8    sourceVersion: {
9      sourceVersion: {
10        id: "0Fcxx000000xxxxxx",
11      },
12    },
13  };
14
15  create(event) {
16    createDatasetVersion({ datasetVersion: this.datasetVersion })
17      .then(() => {
18        this.dispatchEvent(
19          new ShowToastEvent({
20            title: "Success",
21            message: "Dataset Version Created",
22            variant: "success",
23          }),
24        );
25      })
26      .catch((error) => {
27        this.dispatchEvent(
28          new ShowToastEvent({
29            title: "Error creating dataset version",
30            message: error.body.message,
31            variant: "error",
32          }),
33        );
34      });
35  }
36}

This button calls the createDatasetVersion() method.

1<template>
2  <lightning-button
3    label="Create"
4    icon-name="utility:play"
5    icon-position="right"
6    onclick={create}
7  ></lightning-button>
8</template>