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.

Xmd Resource

Returns the extended metadata (Xmd) for a version of a dataset and updates the user Xmd file.

Resource URL

1/wave/datasets/<datasetID>/versions/<versionID>/xmds/main

1/wave/datasets/<datasetID>/versions/<versionID>/xmds/system

1/wave/datasets/<datasetID>/versions/<versionID>/xmds/user

For full details on Xmd, refer to the Analytics Extended Metadata (Xmd) Reference.

Formats

JSON

Available Version

36.0

Available Components

LWC — lightning/analyticsWaveApi getXmd()
LWC — lightning/analyticsWaveApi updateXmd()

HTTP Methods

GET PUT (on Xmd User type only)

GET Response Body

Xmd

PUT Request Body

Xmd Input

The following JSON shows a PUT request to update measures in the User Xmd. The PUT request cannot be used to update System or Main Xmd types.

1{
2  "measures" : [ {
3    "conditionalFormatting" : { },
4    "field" : "LastModifiedDate_day_epoch",
5    "format" : {
6      "delimiters" : { }
7    },
8    "label" : "LastModDate_day_epoch",
9    "showInExplorer" : true
10  }, {
11    "conditionalFormatting" : { },
12    "field" : "LastModifiedDate_sec_epoch",
13    "format" : {
14      "delimiters" : { }
15    },
16    "label" : "LastModDate_sec_epoch",
17    "showInExplorer" : true
18  } ]
19}

PUT Response Body

Xmd

CRM Analytics REST API Developer Guide