getXmd

Retrieves a specific CRM Analytics extended metadata type (Xmd) for a version of a dataset.

Syntax 

1import { LightningElement, api, wire } from "lwc";
2import { getXmd } from "lightning/analyticsWaveApi";
3
4export default class GetXmd extends LightningElement {
5  @api idOrApiName; // or fetch the ID or dev name
6  @api vId; // or fetch the version ID
7  type = "Main";
8  @wire(getXmd, {
9    datasetIdOrApiName: "$idOrApiName",
10    versionId: "${vId}",
11    xmdType: "${type}",
12  })
13  onGetXmd({ data, error }) {
14    if (error) {
15      console.log(`getXmd(${idOrApiName}, ${versionId}, ${xmdType}) ERROR:`, error);
16    } else if (data) {
17      console.log(`getXmd(${idOrApiName}, ${versionId}, ${xmdType}) RESPONSE:`, data);
18    }
19  }
20}

CRM Analytics API Resource 

1GET /wave/datasets/${datasetIdOrApiName}/versions/${versionId}/xmds/${xmdType}

getXmd uses this CRM Analytics API resource.

Parameters 

Parameter NameTypeDescriptionRequired?
datasetIdOrApiNameStringThe ID or developer name of the dataset.Yes
versionIdStringThe ID of the dataset version.Yes
xmdTypeStringThe xmd type.
  • Asset
  • Main
  • System
  • User
Yes

Returns