Wave REST API Developer Guide

Working with the Wave REST API
Wave REST API Reference
Wave REST API Resources Overview
Wave Resource
Query Resource
Datasets List Resource
Dataset Resource
Versions List Resource
Version Resource
File Resource
XMD List Resource
XMD Resource
Lenses List Resource
Lens Resource
Lens File Resource
Lens File Metadata Resource
Dashboards List Resource
Dashboard Resource
Dependencies Resource
Features Configuration Resource
Folders List Resource
Folder Resource
Replicated Datasets Resource
Replicated Datasets List Resource
Replicated Dataset Fields Resource
Templates List Resource
Templates Resource
Templates Configuration Resource
Trended Reports List Resource
Trended Reports Resource
Annotations List Resource
Annotation Resource
Template Release Notes Resource
PDF

Newer Version Available

This content describes an older version of this product. View Latest

XMD Resource

Returns the extended metadata (XMD) for a version of a dataset (GET) and replaces the user XMD file (PUT).
Resource URL
1/wave/datasets/<dataset ID>/versions/<version ID>/xmds/main
1/wave/datasets/<dataset ID>/versions/<version ID>/xmds/system
1/wave/datasets/<dataset ID>/versions/<version ID>/xmds/user
Formats
JSON
Available Version
36.0
HTTP Methods
GET and PUT (on /wave/datasets/<dataset ID>/versions/<version ID>/xmds/user only)
GET Response Body
Property Name Type Description Filter Group and Version Available Version
createdBy Wave User The creator of the XMD. Small, 36.0 36.0
createdDate Date The time at which the XMD was created, in ISO8601 date format. Small, 36.0 36.0
dataset XMD Dataset Locale-specific information about the dataset represented by this XMD. Small, 36.0 36.0
dates XMD Date[] A list of dates with formatting information. Small, 36.0 36.0
derived​Dimensions XMD Dimension[] A list of derived dimensions with formatting information. Small, 36.0 36.0
derived​Measures XMD Measure[] List of derived measures with formatting information. Small, 36.0 36.0
dimensions XMD Dimension[] List of dimensions with formatting information. Small, 36.0 36.0
error​Message String Message if there was error copying forward the current version's user XMD to the newly created version. Small, 37.0 37.0
language String The language in which this XMD is localized. Values are:
  • bg: Bulgarian
  • zh_CN: Chinese ​Simplified
  • zh_TW: Chinese ​Traditional
  • hr: Croatian
  • cs: Czech
  • da: Danish
  • nl_NL: Dutch
  • en: English
  • en_GB: English ​(United Kingdom)
  • fi: Finnish
  • fr: French
  • de: German
  • el: Greek
  • hu: Hungarian
  • in: Indonesian
  • it: Italian
  • ja: Japanese
  • ko: Korean
  • no: Norwegian
  • pl: Polish
  • pt_PT: Portuguese ​(Portugal)
  • pt_BR: Portuguese ​(Brazil)
  • ro: Romanian
  • ru: Russian
  • sk: Slovak
  • sl: Slovenian
  • es: Spanish
  • es_MX: Spanish ​(Mexico)
  • sv: Swedish
  • th: Thai
  • tr: Turkish
  • uk: Ukrainian
  • vi: Vietnamese
 Small, 36.0 36.0
last​Modified​By Wave User The user who last updated the XMD. Small, 36.0 36.0
last​Modified​Date Date The last time the XMD was modified, in ISO8601 date format. Small, 36.0 36.0
measures XMD Measure[] List of measures with formatting information. Small, 36.0 36.0
organizations XMD Organization[] List of organizations for multi-organization support. Small, 36.0 36.0
show​Details​Default​Fields String[] Ordered list of dimensions and measures. The list defines the default order in which to show the dimensions and measures in the user interface. Small, 36.0 36.0
type String The type of XMD. Values are:
  • main
  • system
  • user
 Small, 36.0 36.0
url String The location where this XMD is stored. Small, 36.0 36.0
XMD Dataset
Property Name Type Description Filter Group and Version Available Version
connector String The connector source for the dataset. Small, 36.0 36.0
description String The description of the dataset. Small, 36.0 36.0
fully​Qualified​Name String The fully qualified name of the dataset version. Small, 36.0 36.0
origin String The origin of the dataset version. Small, 36.0 36.0
XMD Date
Property Name Type Description Filter Group and Version Available Version
alias String The alias of the date column. Small, 36.0 36.0
compact Boolean Indicates whether the date is displayed as compact. Small, 36.0 36.0
description String The description of the date column. Small, 36.0 36.0
fields XMD Date Field Formatting information for the date fields. Small, 36.0 36.0
first​Day​Of​Week Integer The first day of the week. Use 0 to set the first day to be Sunday, 1 to set the first day to be Monday, and so on. Small, 36.0 36.0
fiscal​Month​Offset Integer The offset, in months, that the fiscal year differs from the calendar year. Represented as the month number - 1. For example, if the fiscal year starts in January, the offset is 0 (1 - 1). If the fiscal year starts in October, the offset is 9 (10 - 1). Small, 36.0 36.0
is​Year​End​Fiscal​Year Boolean Indicates whether the year end is based on the fiscal year. Small, 36.0 36.0
label String The label of the date column. Small, 36.0 36.0
show​In​Explorer Boolean Indicates whether the date is displayed in the explorer. Small, 36.0 36.0
XMD Date Field
Property Name Type Description Filter Group and Version Available Version
day String The day field. Small, 36.0 36.0
epoch​Day String The epoch day field. Small, 36.0 36.0
epoch​Second String The epoch second field. Small, 36.0 36.0
fiscal​Month String The fiscal month field. Small, 36.0 36.0
fiscal​Quarter String The fiscal quarter field. Small, 36.0 36.0
fiscal​Week String The fiscal week field. Small, 36.0 36.0
fiscal​Year String The fiscal year field. Small, 36.0 36.0
full​Field String The full-field field. Small, 36.0 36.0
hour String The hour field. Small, 36.0 36.0
minute String The minute field. Small, 36.0 36.0
month String The month field. Small, 36.0 36.0
quarter String The quarter field. Small, 36.0 36.0
second String The second field Small, 36.0 36.0
week String The week field. Small, 36.0 36.0
year String The year field. Small, 36.0 36.0
XMD Dimension
Property Name Type Description Filter Group and Version Available Version
custom​Actions XMD Dimension Custom Action[] Custom actions linked to this dimension. Small, 36.0 36.0
custom​Actions​Enabled Boolean Indicates whether the dimension has custom actions enabled. Small, 36.0 36.0
date​Format String The format used for a date that is a dimension. Small, 36.0 36.0
description String The description of the dimension. Small, 36.0 36.0
field String The field name of the dimension (used in queries). Small, 36.0 36.0
fully​Qualified​Name String The fully qualified name of the dimension. Small, 36.0 36.0
image​Template String The image template. Small, 36.0 36.0
is​Multi​Value Boolean Indicates whether the dimension is multi-value. Small, 36.0 36.0
label String The label for the dimension. Small, 36.0 36.0
link​Template String The template for formatting a link. Small, 36.0 36.0
link​Template​Enabled Boolean Indicates whether the dimension has link templates enabled. Small, 36.0 36.0
link​Tool​tip String The tooltip to be displayed for links. Small, 36.0 36.0
members XMD Dimension Member[] The member overrides for a dimension. Small, 36.0 36.0
origin String The origin of this dimension. Small, 36.0 36.0
record​Display​Fields String[] Ordered list of dimensions and measures. The list defines the default order to in which to display the dimensions and measures in the user interface. Small, 36.0 36.0
record​Id​Field String The record ID for this dimension. Small, 36.0 36.0
record​Organization​Id​Field String The record organization ID for this dimension. Small, 36.0 36.0
salesforce​Actions XMD Dimension Salesforce Action[] Salesforce actions linked to this dimension. Small, 36.0 36.0
salesforce​Actions​Enabled Boolean Indicates whether the dimension has Salesforce actions enabled. Small, 36.0 36.0
show​In​Explorer Boolean Indicates whether the dimension is displayed in the explorer. Small, 36.0 36.0
XMD Dimension Custom Action
Property Name Type Description Filter Group and Version Available Version
enabled Boolean Indicates whether the action is enabled for a specific dimension. Small, 36.0 36.0
icon String The icon for the action. Small, 36.0 36.0
method String The method for the action. Small, 36.0 36.0
name String The name of the action. Small, 36.0 36.0
target String The target for the action. Small, 36.0 36.0
tooltip String The tooltip for the action. Small, 36.0 36.0
url String The URL for the action. Small, 36.0 36.0
XMD Dimension Member
Property Name Type Description Filter Group and Version Available Version
color String The color for the member. Small, 36.0 36.0
label String The label for the member. Small, 36.0 36.0
member String The member value. Small, 36.0 36.0
XMD Dimension Salesforce Action
Property Name Type Description Filter Group and Version Available Version
enabled Boolean Indicates whether the action is enabled for a specific dimension. Small, 36.0 36.0
name String The name of the action. Small, 36.0 36.0
XMD Measure
Property Name Type Description Filter Group and Version Available Version
date​Format String The format used for a date that is a measure. Small, 36.0 36.0
description String The description of the measure. Small, 36.0 36.0
field String The field name of the measure (used in queries). Small, 36.0 36.0
format XMD Measure Format The format details for the measure. Small, 36.0 36.0
fully​Qualified​Name String The fully qualified name of the measure. Small, 36.0 36.0
label String The label for the measure. Small, 36.0 36.0
origin String The origin of the measure. Small, 36.0 36.0
show​In​Explorer Boolean Indicates whether the measure is displayed in the explorer. Small, 36.0 36.0
XMD Measure Format
Property Name Type Description Filter Group and Version Available Version
custom​Format String The original (XMD 1.1) format array as a single string. Small, 36.0 36.0
decimal​Digits Integer The number of digits displayed after the decimal place. Small, 36.0 36.0
negative​Parentheses Boolean Indicates whether to display negative numbers with parentheses, rather than a minus sign. Small, 36.0 36.0
prefix String The prefix placed before the field value. Small, 36.0 36.0
suffix String The suffix placed after the field value. Small, 36.0 36.0
unit String The unit string for the measure. For example, 'cm'. Small, 36.0 36.0
unit​Multiplier Double The multiplier for the unit. Small, 36.0 36.0
XMD Organization
Property Name Type Description Filter Group and Version Available Version
id String The ID of the organization. Small, 36.0 36.0
instance​Url String The instance URL for the organization. Small, 36.0 36.0
label String The label for the organization. Small, 36.0 36.0
PUT Request Body
Property Name Type Description Required or Optional Available Version
dataset Xmd​Dataset​Input​Representation Locale-specific information about the Dataset represented by this XMD. 36.0
dates Xmd​Date​Input​Representation[] List of dates with formatting information. 36.0
derived​Dimensions Xmd​Derived​Dimension​Input​Representation[] List of derived dimensions with formatting information. 36.0
derived​Measures Xmd​Derived​Measure​Input​Representation[] List of derived measures with formatting information. 36.0
dimensions Xmd​Dimension​Input​Representation[] List of dimensions with formatting information. 36.0
measures Xmd​Measure​Input​Representation[] List of measures with formatting information. 36.0
organizations Xmd​Organization​Input​Representation[] List of organizations for multi-organization support. 36.0
show​Details​Default​Fields String[] Ordered list of Dimensions and Measures. Represents the default order to show them in the UI. 36.0
XmdDatasetInputRepresentation
Property Name Type Description Required or Optional Available Version
connector String Connector source for the dataset. 36.0
description String Description of the dataset. 36.0
fully​Qualified​Name String Fully qualified name of the dataset version. 36.0
origin String Origin representing where this dataset version comes from. 36.0
XmdDateInputRepresentation
Property Name Type Description Required or Optional Available Version
alias String Alias of the Date column. 36.0
compact Boolean Whether the Date should be displayed as compact. 36.0
description String Description of the Date column. 36.0
fields Xmd​Date​Fields​Input​Representation Formatting information for the date fields. 36.0
first​Day​Of​Week Integer What the first day of the week is. 36.0
fiscal​Month​Offset Integer Offset number of months for the fiscal year in relation to the calendar year. 36.0
is​Year​End​Fiscal​Year Boolean Whether the Year End is the Fiscal year. 36.0
label String Label of the Date column. 36.0
show​In​Explorer Boolean Whether the Date should be show in the explorer. 36.0
XmdDateFieldsInputRepresentation
Property Name Type Description Required or Optional Available Version
day String day field. 36.0
epochDay String epochDay field. 36.0
epochSecond String epochSecond field. 36.0
fiscalMonth String fiscalMonth field. 36.0
fiscalQuarter String fiscalQuarter field. 36.0
fiscalWeek String fiscalWeek field. 36.0
fiscalYear String fiscalYear field. 36.0
fullField String fullField field. 36.0
hour String hour field. 36.0
minute String minute field. 36.0
month String month field. 36.0
quarter String quarter field. 36.0
second String second field. 36.0
week String week field. 36.0
year String year field. 36.0
XmdDerivedDimensionInputRepresentation
Property Name Type Description Required or Optional Available Version
custom​Actions Xmd​Derived​Dimension​Custom​Action​Input​Representation[] Custom Actions linked to this Derived Dimension. 36.0
is​Multi​Value Boolean Whether the Derived Dimension is multi-value. 36.0
members Xmd​Derived​Dimension​Member​Input​Representation[] Member overrides for a Derived Dimension. 36.0
salesforce​Actions Xmd​Derived​Dimension​Salesforce​Action​Input​Representation[] Salesforce Actions linked to this Derived Dimension. 36.0
XmdDerivedDimensionCustomActionInputRepresentation
Property Name Type Description Required or Optional Available Version
icon String Icon for the action. 36.0
method String Method for the action. 36.0
target String Target for the action. 36.0
tooltip String Tooltip for the action. 36.0
url String Url for the action. 36.0
XmdDerivedDimensionMemberInputRepresentation
Property Name Type Description Required or Optional Available Version
color String Color for the member. 36.0
label String Label for the member. 36.0
member String Member value. 36.0
XmdDerivedDimensionSalesforceActionInputRepresentation
Property Name Type Description Required or Optional Available Version
enabled Boolean Whether the Action is enabled. 36.0
name String Name of the action. 36.0
XmdDerivedMeasureInputRepresentation
Property Name Type Description Required or Optional Available Version
format Xmd​Derived​Measure​Format​Input​Representation Format details for the Derived Measure. 36.0
dateFormat String Date format to be used for a Date that is a measure. 36.0
description String Description of the Measure. 36.0
field String Field name of the Measure (used in queries). 36.0
fully​Qualified​Name String Fully qualified name of the Measure. 36.0
label String Label for the Measure. 36.0
origin String Origin of the Measure. 36.0
show​In​Explorer Boolean Whether the Measure should be shown in the Explorer. 36.0
XmdDerivedMeasureFormatInputRepresentation
Property Name Type Description Required or Optional Available Version
custom​Format String Displays the original XMD 1.1 format array as a String. 38.0
decimal​Digits Integer Number of digits to be displayed after the decimal place. 36.0
negative​Parentheses Boolean Displays negative numbers with parenthesis or not minus sign 36.0
prefix String Prefix to be placed before the field value. 36.0
suffix String Suffix to be placed after the field value. 36.0
unit String Unit string for the measure. (for example, 'cm') 36.0
unit​Multiplier Double Multiplier for the unit. 36.0
XmdDimensionInputRepresentation
Property Name Type Description Required or Optional Available Version
custom​Actions Xmd​Dimension​Custom​Action​Input​Representation[] Custom Actions linked to this Dimension. 36.0
customActionsEnabled Boolean Whether the Dimension has custom actions enabled. 36.0
dateFormat String Date format to be used for a Date that is a dimension. 36.0
description String Description of the Dimension. 36.0
field String Field name of the Dimension (used in queries). 36.0
fullyQualifiedName String Fully qualified name of the dimension. 36.0
imageTemplate String Image template. 36.0
label String Label for the Dimension. 36.0
linkTemplate String Template for formatting a Link. 36.0
linkTemplateEnabled Boolean Whether the Dimension has link templates enabled. 36.0
linkTooltip String Tooltip to be displayed for links. 36.0
members Xmd​Dimension​Member​Input​Representation[] Member overrides for a Dimension. 36.0
origin String Origin of this dimension. 36.0
recordDisplayFields String[] Ordered list of Dimensions and Measures. Represents the default order to show them in the UI. 36.0
recordIdField String Record Id for this dimension. 36.0
recordOrganizationIdField String Record Organization Id for this dimension. 36.0
salesforce​Actions Xmd​Dimension​Salesforce​Action​Input​Representation[] Salesforce Actions linked to this Dimension. 36.0
salesforceActionsEnabled Boolean Whether the Dimension has salesforce actions enabled. 36.0
showInExplorer Boolean Whether the Dimension should be shown in the Explorer. 36.0
XmdDimensionCustomActionInputRepresentation
Property Name Type Description Required or Optional Available Version
icon String Icon for the action. 36.0
method String Method for the action. 36.0
target String Target for the action. 36.0
tooltip String Tooltip for the action. 36.0
url String Url for the action. 36.0
enabled Boolean Whether the Action is enabled. 36.0
name String Name of the action. 36.0
XmdDimensionMemberInputRepresentation
Property Name Type Description Required or Optional Available Version
color String Color for the member. 36.0
label String Label for the member. 36.0
member String Member value. 36.0
XmdDimensionSalesforceActionInputRepresentation
Property Name Type Description Required or Optional Available Version
enabled Boolean Whether the Action is enabled. 36.0
name String Name of the action. 36.0
XmdDimensionInputRepresentation
Property Name Type Description Required or Optional Available Version
custom​Actions Xmd​Dimension​Custom​Action​Input​Representation[] Custom Actions linked to this Dimension. 36.0
custom​Actions​Enabled Boolean Whether the Dimension has custom actions enabled. 36.0
date​Format String Date format to be used for a Date that is a dimension. 36.0
description String Description of the Dimension. 36.0
field String Field name of the Dimension (used in queries). 36.0
fully​Qualified​Name String Fully qualified name of the dimension. 36.0
image​Template String Image template. 36.0
label String Label for the Dimension. 36.0
link​Template String Template for formatting a Link. 36.0
link​Template​Enabled Boolean Whether the Dimension has link templates enabled. 36.0
link​Tooltip String Tooltip to be displayed for links. 36.0
members Xmd​Dimension​Member​Input​Representation[] Member overrides for a Dimension. 36.0
origin String Origin of this dimension. 36.0
record​Display​Fields String[] Ordered list of Dimensions and Measures. Represents the default order to show them in the UI. 36.0
record​Id​Field String Record Id for this dimension. 36.0
record​Organization​Id​Field String Record Organization Id for this dimension. 36.0
salesforce​Actions Xmd​Dimension​Salesforce​Action​Input​Representation[] Salesforce Actions linked to this Dimension. 36.0
salesforce​Actions​Enabled Boolean Whether the Dimension has Salesforce actions enabled. 36.0
show​In​Explorer Boolean Whether the Dimension should be shown in the Explorer. 36.0
XmdMeasureInputRepresentation
Property Name Type Description Required or Optional Available Version
format Xmd​Measure​Format​Input​Representation Format details for the Measure. 36.0
date​Format String Date format to be used for a Date that is a measure. 36.0
description String Description of the Measure. 36.0
field String Field name of the Measure (used in queries). 36.0
fully​Qualified​Name String Fully qualified name of the Measure. 36.0
label String Label for the Measure. 36.0
origin String Origin of the Measure. 36.0
show​In​Explorer Boolean Whether the Measure should be shown in the Explorer. 36.0
XmdMeasureFormatInputRepresentation
Property Name Type Description Required or Optional Available Version
custom​Format String Displays the original XMD 1.1 format array as a String. 38.0
decimal​Digits Integer Number of digits to be displayed after the decimal place. 36.0
negative​Parentheses Boolean Displays negative numbers with parenthesis or not minus sign 36.0
prefix String Prefix to be placed before the field value. 36.0
suffix String Suffix to be placed after the field value. 36.0
unit String Unit string for the measure. (for example, 'cm') 36.0
unit​Multiplier Double Multiplier for the unit. 36.0
XmdOrganizationInputRepresentation
Property Name Type Description Required or Optional Available Version
id ID ID of the organization. 36.0
instance​Url String Instance Url for the organization. 36.0
label String Label for the organization. 36.0