この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

Wave REST API 開発者ガイド

Wave REST API の使用
Wave REST API リファレンス
Wave REST API リソースの概要
Wave リソース
Query リソース
Datasets List リソース
Dataset リソース
Versions List リソース
Version リソース
File リソース
XMD List リソース
XMD リソース
Lenses List リソース
Lens リソース
Lens File リソース
Lens File Metadata リソース
Dashboards List リソース
Dashboard リソース
Dependencies リソース
Features Configuration リソース
Folders List リソース
Folder リソース
Templates List リソース
Templates リソース
Templates Configuration リソース
Annotations List リソース
Annotation リソース
Template Release Notes リソース
PDF

XMD リソース

データセットのバージョンの拡張メタデータ (XMD) を返し (GET)、ユーザ XMD ファイルを置き換えます (PUT)。
リソース 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
形式
JSON
使用可能なバージョン
36.0
HTTP メソッド
GET と PUT (/wave/datasets/<データセット ID>/versions/<バージョン ID>/xmds/user 上のみ)
GET のレスポンスボディ
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン
createdBy Wave User XMD の作成者。 Small、36.0 36.0
createdDate Data XMD が作成された時刻 (ISO8601 日付形式)。 Small、36.0 36.0
dataset XMD Dataset この XMD によって表現されるデータセットについてのロケール固有の情報。 Small、36.0 36.0
dates XMD Date[] 書式情報付きの日付リスト。 Small、36.0 36.0
dimensions XMD Dimension[] 書式情報付きのディメンションリスト。 Small、36.0 36.0
language String この XMD がローカライズされている言語。値は次のとおりです。
  • bg: ブルガリア語
  • zh_CN: 中国語 (簡体字)
  • zh_TW: 中国語 (繁体字)
  • hr: クロアチア語
  • cs: チェコ語
  • da: デンマーク語
  • nl_NL: オランダ語
  • en: 英語
  • en_GB: 英語 (イギリス)
  • fi: フィンランド語
  • fr: フランス語
  • de: ドイツ語
  • el: ギリシャ語
  • hu: ハンガリー語
  • in: インドネシア語
  • it: イタリア語
  • ja: 日本語
  • ko: 韓国語
  • no: ノルウェー語
  • pl: ポーランド語
  • pt_PT: ポルトガル語 (ポルトガル)
  • pt_BR: ポルトガル語 (ブラジル)
  • ro: ルーマニア語
  • ru: ロシア語
  • sk: スロバキア語
  • sl: スロベニア語
  • es: スペイン語
  • es_MX: スペイン語 (メキシコ)
  • sv: スウェーデン語
  • th: タイ語
  • tr: トルコ語
  • uk: ウクライナ語
  • vi: ベトナム語
 Small、36.0 36.0
lastModifiedBy Wave User 最後に XMD を更新したユーザ。 Small、36.0 36.0
lastModifiedDate Data XMD が最後に更新された時刻 (ISO8601 日付形式)。 Small、36.0 36.0
measures XMD Measure[] 書式情報付きの基準リスト。 Small、36.0 36.0
organizations XMD Organization[] 複数組織をサポートするための組織のリスト。 Small、36.0 36.0
showDetailsDefaultFields String [] ディメンションおよび基準の順序付きリスト。このリストは、ユーザインターフェースで表示されるディメンションおよび基準のデフォルトの順序を定義します。 Small、36.0 36.0
type String XMD の種別。値は次のとおりです。
  • main
  • system
  • user
 Small、36.0 36.0
url String この XMD が保存されている場所。 Small、36.0 36.0
XMD Dataset
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン
connector String データセットのコネクタソース。 Small、36.0 36.0
description String データセットの説明。 Small、36.0 36.0
fullyQualifiedName String データセットバージョンの完全修飾名。 Small、36.0 36.0
origin String データセットバージョンの発生源。 Small、36.0 36.0
XMD Date
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン
alias String 日付列の別名。 Small、36.0 36.0
compact Boolean 日付がコンパクトとして表示されるかどうかを示します。 Small、36.0 36.0
description String 日付列の説明。 Small、36.0 36.0
fields XMD Date Field 日付項目の書式情報。 Small、36.0 36.0
firstDayOfWeek Integer 週の開始曜日。開始曜日を日曜日に設定するには 0、月曜日に設定するには 1 などのように使用します。 Small、36.0 36.0
fiscalMonthOffset Integer 会計年度とカレンダー年との差を示すオフセット (月数)。月数 - 1 で表されます。たとえば、会計年度が 1 月に開始する場合、オフセットは 0 (1 - 1) です。会計年度が 10 月に開始する場合、オフセットは 9 (10 - 1) です。 Small、36.0 36.0
isYearEndFiscalYear Boolean 1 年の終わりが会計年度に基づくかどうかを示します。 Small、36.0 36.0
label String 日付列の表示ラベル。 Small、36.0 36.0
showInExplorer Boolean 日付がエクスプローラで表示されるかどうかを示します。 Small、36.0 36.0
XMD Date Field
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン
day String 日項目。 Small、36.0 36.0
epochDay String エポック日項目。 Small、36.0 36.0
epochSecond String エポック秒項目。 Small、36.0 36.0
fiscalMonth String 会計月項目。 Small、36.0 36.0
fiscalQuarter String 会計四半期項目。 Small、36.0 36.0
fiscalWeek String 会計週項目。 Small、36.0 36.0
fiscalYear String 会計年度項目。 Small、36.0 36.0
fullField String 完全項目。 Small、36.0 36.0
hour String 時間項目。 Small、36.0 36.0
minute String 分項目。 Small、36.0 36.0
month String 月項目。 Small、36.0 36.0
quarter String 四半期項目。 Small、36.0 36.0
second String 秒項目。 Small、36.0 36.0
week String 週項目。 Small、36.0 36.0
year String 年項目。 Small、36.0 36.0
XMD Dimension
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン
customActions XMD Dimension Custom Action[] このディメンションにリンクされているカスタムアクション。 Small、36.0 36.0
customActionsEnabled Boolean ディメンションでカスタムアクションが有効になっているかどうかを示します。 Small、36.0 36.0
dateFormat String ディメンションである日付に使用される書式。 Small、36.0 36.0
description String ディメンションの説明。 Small、36.0 36.0
field String ディメンションの項目名 (クエリで使用)。 Small、36.0 36.0
fullyQualifiedName String ディメンションの完全修飾名。 Small、36.0 36.0
imageTemplate String 画像テンプレート。 Small、36.0 36.0
isMultiValue Boolean ディメンションが複数値であるかどうかを示します。 Small、36.0 36.0
label String ディメンションの表示ラベル。 Small、36.0 36.0
linkTemplate String リンクの書式設定用テンプレート。 Small、36.0 36.0
linkTemplateEnabled Boolean ディメンションでリンクテンプレートが有効になっているかどうかを示します。 Small、36.0 36.0
linkTooltip String リンクに表示されるツールチップ。 Small、36.0 36.0
members XMD Dimension Member[] ディメンションのメンバーの上書き。 Small、36.0 36.0
origin String このディメンションの発生源。 Small、36.0 36.0
recordDisplayFields String [] ディメンションおよび基準の順序付きリスト。このリストは、ユーザインターフェースでディメンションおよび基準が表示されるデフォルトの順序を定義します。 Small、36.0 36.0
recordIdField String このディメンションのレコード ID。 Small、36.0 36.0
recordOrganizationIdField String このディメンションのレコード組織 ID。 Small、36.0 36.0
salesforceActions XMD Dimension Salesforce Action[] このディメンションにリンクされている Salesforce アクション。 Small、36.0 36.0
salesforceActionsEnabled Boolean ディメンションで Salesforce アクションが有効になっているかどうかを示します。 Small、36.0 36.0
showInExplorer Boolean ディメンションがエクスプローラで表示されるかどうかを示します。 Small、36.0 36.0
XMD Dimension Custom Action
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン
enabled Boolean 特定のディメンションに対してアクションが有効になっているかどうかを示します。 Small、36.0 36.0
icon String アクションのアイコン。 Small、36.0 36.0
method String アクションのメソッド。 Small、36.0 36.0
name String アクションの名前。 Small、36.0 36.0
target String アクションのターゲット。 Small、36.0 36.0
tooltip String アクションのツールチップ。 Small、36.0 36.0
url String アクションの URL。 Small、36.0 36.0
XMD Dimension Member
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン
color String メンバーの色。 Small、36.0 36.0
label String メンバーの表示ラベル。 Small、36.0 36.0
member String メンバー値。 Small、36.0 36.0
XMD Dimension Salesforce Action
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン
enabled Boolean 特定のディメンションに対してアクションが有効になっているかどうかを示します。 Small、36.0 36.0
name String アクションの名前。 Small、36.0 36.0
XMD Measure
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン
dateFormat String 基準である日付に使用される書式。 Small、36.0 36.0
description String 基準の説明。 Small、36.0 36.0
field String 基準の項目名 (クエリで使用)。 Small、36.0 36.0
format XMD Measure Format 基準の書式詳細。 Small、36.0 36.0
fullyQualifiedName String 基準の完全修飾名。 Small、36.0 36.0
label String 基準の表示ラベル。 Small、36.0 36.0
origin String 基準の発生源。 Small、36.0 36.0
showInExplorer Boolean 基準がエクスプローラで表示されるかどうかを示します。 Small、36.0 36.0
XMD Measure Format
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン
decimalDigits Integer 小数点の後に表示される桁数。 Small、36.0 36.0
negativeParentheses Boolean 負の数値をマイナス記号ではなく括弧を使用して表示するかどうかを示します。 Small、36.0 36.0
prefix String 項目値の前に置かれるプレフィックス。 Small、36.0 36.0
suffix String 項目値の後に置かれるサフィックス。 Small、36.0 36.0
unit String 基準の単位文字列 (「cm」など)。 Small、36.0 36.0
unitMultiplier Double 単位乗数。 Small、36.0 36.0
XMD Organization
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン
id String 組織の ID。 Small、36.0 36.0
instanceUrl String 組織のインスタンス URL。 Small、36.0 36.0
label String 組織の表示ラベル。 Small、36.0 36.0
PUT のリクエストボディ
プロパティ名 型 説明 必須項目/省略可能 使用可能なバージョン
dataset Xmd​Dataset​Input​Representation この XMD によって表現されるデータセットについてのロケール固有の情報。 36.0
dates Xmd​Date​Input​Representation[] 書式情報付きの日付リスト。 36.0
derived​Dimensions Xmd​Derived​Dimension​Input​Representation[] 書式情報付きの派生ディメンションリスト。 36.0
derived​Measures Xmd​Derived​Measure​Input​Representation[] 書式情報付きの派生基準リスト。 36.0
dimensions Xmd​Dimension​Input​Representation[] 書式情報付きのディメンションリスト。 36.0
measures Xmd​Measure​Input​Representation[] 書式情報付きの基準リスト。 36.0
organizations Xmd​Organization​Input​Representation[] 複数組織をサポートするための組織のリスト。 36.0
show​Details​Default​Fields String [] ディメンションおよび基準の順序付きリスト。UI で表示するデフォルトの順序を表します。 36.0
XmdDatasetInputRepresentation
プロパティ名 型 説明 必須項目/省略可能 使用可能なバージョン
connector String データセットのコネクタソース。 36.0
description String データセットの説明。 36.0
fully​Qualified​Name String データセットバージョンの完全修飾名。 36.0
origin String このデータセットバージョンのソースを表す発生源。 36.0
XmdDateInputRepresentation
プロパティ名 型 説明 必須項目/省略可能 使用可能なバージョン
alias String 日付列の別名。 36.0
compact Boolean 日付がコンパクトとして表示されるかどうか。 36.0
description String 日付列の説明。 36.0
fields Xmd​Date​Fields​Input​Representation 日付項目の書式情報。 36.0
first​Day​Of​Week Integer 週の開始曜日。 36.0
fiscal​Month​Offset Integer カレンダー年に対する会計年度のオフセット (月数)。 36.0
is​Year​End​Fiscal​Year Boolean 1 年の終わりが会計年度であるかどうか。 36.0
label String 日付列の表示ラベル。 36.0
show​In​Explorer Boolean 日付がエクスプローラで表示されるかどうか。 36.0
XmdDateFieldsInputRepresentation
プロパティ名 型 説明 必須項目/省略可能 使用可能なバージョン
day String 日項目。 36.0
epochDay String エポック日項目。 36.0
epochSecond String エポック秒項目。 36.0
fiscalMonth String 会計月項目。 36.0
fiscalQuarter String 会計四半期項目。 36.0
fiscalWeek String 会計週項目。 36.0
fiscalYear String 会計年度項目。 36.0
fullField String 完全項目。 36.0
hour String 時間項目。 36.0
minute String 分項目。 36.0
month String 月項目。 36.0
quarter String 四半期項目。 36.0
second String 秒項目。 36.0
week String 週項目。 36.0
year String 年項目。 36.0
XmdDerivedDimensionInputRepresentation
プロパティ名 型 説明 必須項目/省略可能 使用可能なバージョン
custom​Actions Xmd​Derived​Dimension​Custom​Action​Input​Representation[] この派生ディメンションにリンクされているカスタムアクション。 36.0
is​Multi​Value Boolean 派生ディメンションが複数値であるかどうか。 36.0
members Xmd​Derived​Dimension​Member​Input​Representation[] 派生ディメンションのメンバーの上書き。 36.0
salesforce​Actions Xmd​Derived​Dimension​Salesforce​Action​Input​Representation[] この派生ディメンションにリンクされている Salesforce アクション。 36.0
XmdDerivedDimensionCustomActionInputRepresentation
プロパティ名 型 説明 必須項目/省略可能 使用可能なバージョン
icon String アクションのアイコン。 36.0
method String アクションのメソッド。 36.0
target String アクションのターゲット。 36.0
tooltip String アクションのツールチップ。 36.0
url String アクションの URL。 36.0
XmdDerivedDimensionMemberInputRepresentation
プロパティ名 型 説明 必須項目/省略可能 使用可能なバージョン
color String メンバーの色。 36.0
label String メンバーの表示ラベル。 36.0
member String メンバー値。 36.0
XmdDerivedDimensionSalesforceActionInputRepresentation
プロパティ名 型 説明 必須項目/省略可能 使用可能なバージョン
enabled Boolean アクションが有効になっているかどうか。 36.0
name String アクションの名前。 36.0
XmdDerivedMeasureInputRepresentation
プロパティ名 型 説明 必須項目/省略可能 使用可能なバージョン
format Xmd​Derived​Measure​Format​Input​Representation 派生基準の書式詳細。 36.0
dateFormat String 基準である日付に使用される日付書式。 36.0
description String 基準の説明。 36.0
field String 基準の項目名 (クエリで使用)。 36.0
fully​Qualified​Name String 基準の完全修飾名。 36.0
label String 基準の表示ラベル。 36.0
origin String 基準の発生源。 36.0
show​In​Explorer Boolean 基準がエクスプローラで表示されるかどうか。 36.0
XmdDerivedMeasureFormatInputRepresentation
プロパティ名 型 説明 必須項目/省略可能 使用可能なバージョン
decimal​Digits Integer 小数点の後に表示される桁数。 36.0
negative​Parentheses Boolean 負の数値をマイナス記号ではなく括弧を使用して表示します。 36.0
prefix String 項目値の前に置かれるプレフィックス。 36.0
suffix String 項目値の後に置かれるサフィックス。 36.0
unit String 基準の単位文字列 (「cm」など)。 36.0
unit​Multiplier Double 単位乗数。 36.0
XmdDimensionInputRepresentation
プロパティ名 型 説明 必須項目/省略可能 使用可能なバージョン
custom​Actions Xmd​Dimension​Custom​Action​Input​Representation[] このディメンションにリンクされているカスタムアクション。 36.0
members Xmd​Dimension​Member​Input​Representation[] ディメンションのメンバーの上書き。 36.0
salesforce​Actions Xmd​Dimension​Salesforce​Action​Input​Representation[] このディメンションにリンクされている Salesforce アクション。 36.0
XmdDimensionCustomActionInputRepresentation
プロパティ名 型 説明 必須項目/省略可能 使用可能なバージョン
icon String アクションのアイコン。 36.0
method String アクションのメソッド。 36.0
target String アクションのターゲット。 36.0
tooltip String アクションのツールチップ。 36.0
url String アクションの URL。 36.0
enabled Boolean アクションが有効になっているかどうか。 36.0
name String アクションの名前。 36.0
XmdDimensionMemberInputRepresentation
プロパティ名 型 説明 必須項目/省略可能 使用可能なバージョン
color String メンバーの色。 36.0
label String メンバーの表示ラベル。 36.0
member String メンバー値。 36.0
XmdDimensionSalesforceActionInputRepresentation
プロパティ名 型 説明 必須項目/省略可能 使用可能なバージョン
enabled Boolean アクションが有効になっているかどうか。 36.0
name String アクションの名前。 36.0
XmdDimensionInputRepresentation
プロパティ名 型 説明 必須項目/省略可能 使用可能なバージョン
custom​Actions Xmd​Dimension​Custom​Action​Input​Representation[] このディメンションにリンクされているカスタムアクション。 36.0
members Xmd​Dimension​Member​Input​Representation[] ディメンションのメンバーの上書き。 36.0
salesforce​Actions Xmd​Dimension​Salesforce​Action​Input​Representation[] このディメンションにリンクされている Salesforce アクション。 36.0
custom​Actions​Enabled Boolean ディメンションでカスタムアクションが有効になっているかどうか。 36.0
date​Format String ディメンションである日付に使用される日付書式。 36.0
description String ディメンションの説明。 36.0
field String ディメンションの項目名 (クエリで使用)。 36.0
fully​Qualified​Name String ディメンションの完全修飾名。 36.0
image​Template String 画像テンプレート。 36.0
label String ディメンションの表示ラベル。 36.0
link​Template String リンクの書式設定用テンプレート。 36.0
link​Template​Enabled Boolean ディメンションでリンクテンプレートが有効になっているかどうか。 36.0
link​Tooltip String リンクに表示されるツールチップ。 36.0
origin String このディメンションの発生源。 36.0
record​Display​Fields String [] ディメンションおよび基準の順序付きリスト。UI で表示するデフォルトの順序を表します。 36.0
record​Id​Field String このディメンションのレコード ID。 36.0
record​Organization​Id​Field String このディメンションのレコード組織 ID。 36.0
salesforce​Actions​Enabled Boolean ディメンションで Salesforce アクションが有効になっているかどうか。 36.0
show​In​Explorer Boolean ディメンションがエクスプローラで表示されるかどうか。 36.0
XmdMeasureInputRepresentation
プロパティ名 型 説明 必須項目/省略可能 使用可能なバージョン
format Xmd​Measure​Format​Input​Representation 基準の書式詳細。 36.0
date​Format String 基準である日付に使用される日付書式。 36.0
description String 基準の説明。 36.0
field String 基準の項目名 (クエリで使用)。 36.0
fully​Qualified​Name String 基準の完全修飾名。 36.0
label String 基準の表示ラベル。 36.0
origin String 基準の発生源。 36.0
show​In​Explorer Boolean 基準がエクスプローラで表示されるかどうか。 36.0
XmdMeasureFormatInputRepresentation
プロパティ名 型 説明 必須項目/省略可能 使用可能なバージョン
decimal​Digits Integer 小数点の後に表示される桁数。 36.0
negative​Parentheses Boolean 負の数値をマイナス記号ではなく括弧を使用して表示します。 36.0
prefix String 項目値の前に置かれるプレフィックス。 36.0
suffix String 項目値の後に置かれるサフィックス。 36.0
unit String 基準の単位文字列 (「cm」など)。 36.0
unit​Multiplier Double 単位乗数。 36.0
XmdOrganizationInputRepresentation
プロパティ名 型 説明 必須項目/省略可能 使用可能なバージョン
id ID 組織の ID。 36.0
instance​Url String 組織のインスタンス URL。 36.0
label String 組織の表示ラベル。 36.0