CRM Analytics REST API 開発者ガイド
jLens リソース
- リソース URL
-
1/wave/lenses/<lensIdOrApiName> - 形式
- JSON
- 使用可能なバージョン
- 36.0
- 使用可能なコンポーネント
-
- Apex — Wave.Lenses.getLens()
- Aura — <wave:sdk> describeLens()
- HTTP のメソッド
- GET DELETE PATCH
- GET レスポンスボディ (LensRepresentation)
-
LensRepresentation は、抽象 BaseTemplatedAssetRepresentation からプロパティを継承します。これらの基本プロパティは、LensRepresentation に、次のテーブルで明示的に定義されたプロパティとともに表示されます。
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン allowPreview Boolean ユーザーがレンズをプレビューできるかどうかを示します。 Small、36.0 36.0 dataset AssetReferenceRepresentation 廃止 このレンズの作成に使用されるデータセットへの参照。 Small、36.0 36.0 ～ 42.0 datasets AssetReferenceRepresentation[] レンズで使用されるデータセットのリスト。 Small、43.0 43.0 dateVersion Integer レンズが使用する日付のバージョン。有効な値は、次のとおりです。 - 1
- 2
Small、44.0 44.0 files LensFileRepresentation[] レンズファイルのリスト。 Medium、36.0 36.0 filesUrl String レンズファイルの URL。 Small、36.0 36.0 folder AssetReferenceRepresentation このレンズが保存されているフォルダーへの参照。 Small、36.0 36.0 historiesUrl String このレンズに関連付けられたレンズ履歴の URL。 Small、44.0 44.0 refreshDate Date レンズで使用されている最新のデータセットの日付 (ISO8601 日付形式)。 Small、36.0 36.0 state LensStateRepresentation レンズの状態。 Big、36.0 36.0 visibility ConnectWaveAssetVisibilityType アセットが参照アクセス権を持つユーザーに対して非表示になるかどうかを示します。有効な値は、次のとおりです。 - All (すべてのアセットを表示)
- Limited (参照アクセス権を持つ閲覧者にアセットを非表示)
Small、51.0 51.0 visualizationType String このレンズに使用される視覚化のタイプ。有効な値は次のとおりです。 - Bullet
- CalendarHeatMap
- Combo
- ComparisonTable
- Flatgauge
- Gauge
- HeatMap
- HorizontalBar
- HorizontalDot
- Line
- Matrix
- ParallelCoordinates
- Pie
- PivotTable
- Polargauge
- Pyramid
- Rating
- Scatter
- StackWaterfall
- StackedHorizontalBar
- StackedVerticalBar
- Time
- TimeBar
- TimeCombo
- ValuesTable
- VerticalBar
- VerticalDot
- Waterfall
Small、36.0 36.0 - PATCH リクエストボディ (LensInputRepresentation)
-
LensInputRepresentation は、抽象 BaseAssetInputRepresentation からプロパティを継承します。これらの基本プロパティは、LensInputRepresentation に、次のテーブルで明示的に定義されたプロパティとともに表示されます。
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン datasets AssetReferenceInputRepresentation[] このレンズの作成に使用されたデータセットのリスト。 POST では必須、PATCH では省略可能 43.0 folder AssetReferenceInputRepresentation このレンズが保存されているフォルダー。 POST では必須、PATCH では省略可能 36.0 historylabel String 保存されるレンズバージョンの履歴の表示ラベル。 省略可能 46.0 state LensStateInputRepresentation レンズの状態。 POST では必須、PATCH では省略可能 36.0 visibility ConnectWaveAssetVisibilityType アセットが参照アクセス権を持つユーザーに対して非表示になるかどうかを示します。有効な値は、次のとおりです。 - All (すべてのアセットを表示)
- Limited (参照アクセス権を持つ閲覧者にアセットを非表示)
省略可能 51.0 visualizationType ConnectWaveVisualizationTypeEnum レンズの視覚化のタイプ。有効な値は、次のとおりです。 - Bullet
- CalendarHeatMap
- Combo
- ComparisonTable
- Flatgauge
- Gauge
- HeatMap
- HorizontalBar
- HorizontalDot
- Line
- Matrix
- ParallelCoordinates
- Pie
- PivotTable
- Polargauge
- Pyramid
- Rating
- Scatter
- StackWaterfall
- StackedHorizontalBar
- StackedVerticalBar
- Time
- TimeBar
- TimeCombo
- ValuesTable
- VerticalBar
- VerticalDot
- Waterfall
POST では必須、PATCH では省略可能 36.0 xmd XmdInputRepresentation レンズのアセット XMD。 省略可能 43.0 - PATCH レスポンスボディ (LensRepresentation)
-
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン allowPreview Boolean ユーザーがレンズをプレビューできるかどうかを示します。 Small、36.0 36.0 dataset AssetReferenceRepresentation 廃止 このレンズの作成に使用されるデータセットへの参照。 Small、36.0 36.0 ～ 42.0 datasets AssetReferenceRepresentation[] レンズで使用されるデータセットのリスト。 Small、43.0 43.0 dateVersion Integer レンズが使用する日付のバージョン。有効な値は、次のとおりです。 - 1
- 2
Small、44.0 44.0 files LensFileRepresentation[] レンズファイルのリスト。 Medium、36.0 36.0 filesUrl String レンズファイルの URL。 Small、36.0 36.0 folder AssetReferenceRepresentation このレンズが保存されているフォルダーへの参照。 Small、36.0 36.0 historiesUrl String このレンズに関連付けられたレンズ履歴の URL。 Small、44.0 44.0 refreshDate Date レンズで使用されている最新のデータセットの日付 (ISO8601 日付形式)。 Small、36.0 36.0 state LensStateRepresentation レンズの状態。 Big、36.0 36.0 visibility ConnectWaveAssetVisibilityType アセットが参照アクセス権を持つユーザーに対して非表示になるかどうかを示します。有効な値は、次のとおりです。 - All (すべてのアセットを表示)
- Limited (参照アクセス権を持つ閲覧者にアセットを非表示)
Small、51.0 51.0 visualizationType String このレンズに使用される視覚化のタイプ。有効な値は次のとおりです。 - Bullet
- CalendarHeatMap
- Combo
- ComparisonTable
- Flatgauge
- Gauge
- HeatMap
- HorizontalBar
- HorizontalDot
- Line
- Matrix
- ParallelCoordinates
- Pie
- PivotTable
- Polargauge
- Pyramid
- Rating
- Scatter
- StackWaterfall
- StackedHorizontalBar
- StackedVerticalBar
- Time
- TimeBar
- TimeCombo
- ValuesTable
- VerticalBar
- VerticalDot
- Waterfall
Small、36.0 36.0
- LensFileRepresentation
-
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン contentType String ファイルの内容タイプ。 Small、36.0 36.0 fileLength Integer ファイルのサイズ (KB)。 Small、36.0 36.0 fileName String ファイルの名前。 Small、36.0 36.0 id ID 18 文字のレンズファイル ID。 Small、36.0 36.0 lastModifiedDate Date ファイルの最終更新日 (ISO8601 日付形式)。 Small、36.0 36.0 url String ファイルの URL。 Small、36.0 36.0 - LensStateRepresentation
-
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン options LensVisualization OptionsRepresentation 異なるレンズの視覚化の設定オプション。有効な値は、次のとおりです。 - BarLensVisualizationOptionsRepresentation
- ComparisonTableLensVisualizationOptionsRepresentation
- DotLensVisualizationOptionsRepresentation
- HeatMapLensVisualizationOptionsRepresentation
- MatrixLensVisualizationOptionsRepresentation
- ParallelCoordsLensVisualizationOptionsRepresentation
- PieLensVisualizationOptionsRepresentation
- PivotTableLensVisualizationOptionsRepresentation
- ScatterLensVisualizationOptionsRepresentation
- StackedBarLensVisualizationOptionsRepresentation
- TableLensVisualizationOptionsRepresentation
- TimeLensVisualizationOptionsRepresentation
- ValuesTableLensVisualizationOptionsRepresentation
Small、36.0 36.0 query QueryRepresentation このレンズの作成に使用される SAQL クエリ。 Small、36.0 36.0 - BarLensVisualizationOptionsRepresentation
-
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン legend Boolean 凡例を表示するか否かを示します。 Small、36.0 36.0 legendHideHeader Boolean 凡例ヘッダーを非表示にするか否かを示します。 Small、36.0 36.0 legendWidth Integer 凡例の幅。 Small、36.0 36.0 maxColumnWidth Integer ヘッダー列の最大幅。 Small、36.0 36.0 minColumnWidth Integer ヘッダー列の最小幅。 Small、36.0 36.0 miniBars Integer ミニバーの幅 (使用されている場合)。 Small、36.0 36.0 multiMetrics Boolean 複数の基準を同じグラフに横並びで表示するか、基準ごとに独自のグラフにするかを示します。 Small、36.0 36.0 splitAxis Boolean 各基準を 1 つの軸に表示するか、すべての基準が軸を共有するかを示します。 Small、36.0 36.0 sqrt Boolean 軸が平方根スケールか否かを示します。 Small、36.0 36.0 trellis Boolean 最後のグループがトレリスのディメンションとして処理されるか否かを示します。ディメンションのすべての個別値がグラフになります。 Small、36.0 36.0 - ComparisonTableLensVisualizationOptionsRepresentation
-
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン maxColumnWidth Integer ヘッダー列の最大幅。 Small、36.0 36.0 minColumnWidth Integer ヘッダー列の最小幅。 Small、36.0 36.0 subtotals Boolean テーブルに小計を表示するか否かを示します。 Small、48.0 48.0 totals Boolean テーブルに合計を表示するか否かを示します。 Small、36.0 36.0 - DotLensVisualizationOptionsRepresentation
-
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン fit Boolean カテゴリの割合に比例するようにデータ図形の位置やサイズを調整するか否かを示します。 Small、36.0 36.0 legend Boolean 凡例を表示するか否かを示します。 Small、36.0 36.0 legendHideHeader Boolean 凡例ヘッダーを非表示にするか否かを示します。 Small、36.0 36.0 legendWidth Integer 凡例の幅。 Small、36.0 36.0 sqrt Boolean 軸が平方根スケールか否かを示します。 Small、36.0 36.0 - HeatMapLensVisualizationOptionsRepresentation
-
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン legendHideHeader Boolean 凡例ヘッダーを非表示にするか否かを示します。 Small、36.0 36.0 legendWidth Integer 凡例の幅。 Small、36.0 36.0 sqrt Boolean 軸が平方根スケールか否かを示します。 Small、36.0 36.0 - MatrixLensVisualizationOptionsRepresentation
-
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン legendHideHeader Boolean 凡例ヘッダーを非表示にするか否かを示します。 Small、36.0 36.0 legendWidth Integer 凡例の幅。 Small、36.0 36.0 sqrt Boolean 軸が平方根スケールか否かを示します。 Small、36.0 36.0 - ParallelCoordsLensVisualizationOptionsRepresentation
-
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン fit Boolean カテゴリの割合に比例するようにデータ図形の位置やサイズを調整するか否かを示します。 Small、36.0 36.0 legend Boolean 凡例を表示するか否かを示します。 Small、36.0 36.0 legendHideHeader Boolean 凡例ヘッダーを非表示にするか否かを示します。 Small、36.0 36.0 legendWidth Integer 凡例の幅。 Small、36.0 36.0 sqrt Boolean 軸が平方根スケールか否かを示します。 Small、36.0 36.0 - PieLensVisualizationOptionsRepresentation
-
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン legendHideHeader Boolean 凡例ヘッダーを非表示にするか否かを示します。 Small、36.0 36.0 legendWidth Integer 凡例の幅。 Small、36.0 36.0 sqrt Boolean 軸が平方根スケールか否かを示します。 Small、36.0 36.0 - PivotTableLensVisualizationOptionsRepresentation
-
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン columnTotals Boolean テーブルに列の合計を表示するか (true)、否か (false) を示します。 Small、55.0 55.0 maxColumnWidth Integer ヘッダー列の最大幅。 Small、36.0 36.0 minColumnWidth Integer ヘッダー列の最小幅。 Small、36.0 36.0 rowTotals Boolean テーブルに行の合計を表示するか (true)、否か (false) を示します。 Small、55.0 55.0 totals Boolean テーブルに合計を表示するか否かを示します。 Small、36.0 36.0 - ScatterLensVisualizationOptionsRepresentation
-
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン fit Boolean カテゴリの割合に比例するようにデータ図形の位置やサイズを調整するか否かを示します。 Small、36.0 36.0 legend Boolean 凡例を表示するか否かを示します。 Small、36.0 36.0 legendHideHeader Boolean 凡例ヘッダーを非表示にするか否かを示します。 Small、36.0 36.0 legendWidth Integer 凡例の幅。 Small、36.0 36.0 sqrt Boolean 軸が平方根スケールか否かを示します。 Small、36.0 36.0 - StackedBarLensVisualizationOptionsRepresentation
-
プロパティ名 型 説明 検索条件グループとバージョン 使用���能なバージョン legend Boolean 凡例を表示するか否かを示します。 Small、36.0 36.0 legendHideHeader Boolean 凡例ヘッダーを非表示にするか否かを示します。 Small、36.0 36.0 legendWidth Integer 凡例の幅。 Small、36.0 36.0 maxColumnWidth Integer ヘッダー列の最大幅。 Small、36.0 36.0 minColumnWidth Integer ヘッダー列の最小幅。 Small、36.0 36.0 miniBars Integer ミニバーの幅 (使用されている場合)。 Small、36.0 36.0 normalize Boolean カテゴリの割合に比例するようにデータ図形の位置やサイズを調整するか否かを示します。 Small、36.0 36.0 sqrt Boolean 軸が平方根スケールか否かを示します。 Small、36.0 36.0 - TableLensVisualizationOptionsRepresentation
-
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン columnTotals Boolean テーブルに列の合計を表示するか (true)、否か (false) を示します。 Small、55.0 55.0 subtotals Boolean テーブルに小計を表示するか否かを示します。 Small、48.0 48.0 rowTotals Boolean テーブルに行の合計を表示するか (true)、否か (false) を示します。 Small、55.0 55.0 totals Boolean テーブルに合計を表示するか否かを示します。 Small、36.0 36.0 - TimeLensVisualizationOptionsRepresentation
-
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン legend Boolean 凡例を表示するか否かを示します。 Small、36.0 36.0 legendHideHeader Boolean 凡例ヘッダーを非表示にするか否かを示します。 Small、36.0 36.0 legendWidth Integer 凡例の幅。 Small、36.0 36.0 multiMetrics Boolean 複数の基準を同じグラフに横並びで表示するか、基準ごとに独自のグラフにするかを示します。 Small、36.0 36.0 sqrt Boolean 軸が平方根スケールか否かを示します。 Small、36.0 36.0 - ValuesTableLensVisualizationOptionsRepresentation
-
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン hideHeaderColumn Boolean ヘッダー列を表示するか否かを示します。 Small、36.0 36.0 maxColumnWidth Integer ヘッダー列の最大幅。 Small、36.0 36.0 minColumnWidth Integer ヘッダー列の最小幅。 Small、36.0 36.0 totals Boolean テーブルに合計を表示するか否かを示します。 Small、36.0 36.0 - QueryRepresentation
-
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン aggregateFilters Object クエリ集計検索条件。 Small、48.0 48.0 limit Object クエリ制限。 Small、48.0 48.0 orders Object クエリ順序。 Small、48.0 48.0 pivotTotals String クエリピボットの合計。 Small、55.0 55.0 query String SAQL クエリテキスト。 Small、36.0 36.0 sourceFilters CompactFormFilterRepresentation クエリソース検索条件。 Small、48.0 48.0 sources CompactFormSourceRepresentation クエリソース。 Small、48.9 48.0 totals String クエリの合計。 Small、55.0 55.0 version Double このクエリのバージョン。 Small、36.0 36.0 - CompactFormFilterRepresentation
-
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン booleanFilterLogic String Boolean 検索条件ロジック。 Small、49.0 49.0 filters Object 検索条件のリスト。 Small、48.0 48.0 - CompactFormSourceRepresentation
-
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン cogroupType ConnectWaveCompactFormCogroupTypeEnum 短縮形式の取得元共通グループ種別。有効な値は、次のとおりです。 - Full
- Inner
- Left
- Right
Small、48.0 48.0 columns CompactFormColumnRepresentation 短縮形式の取得元列。 Small、48.0 48.0 groups Object 短縮形式の取得元グループ。 Small、48.0 48.0 filters Object 短縮形式の取得元列の検索条件。 Small、52.0 52.0 name String 短縮形式の取得元名。 Small、48.0 48.0 - CompactFormColumnRepresentation
-
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン field Object 短縮形式の列項目。 Small、48.0 48.0 formula String 短縮形式の列数式。 Small、48.0 48.0 name String 短縮形式の列の名前。 Small、48.0 48.0