CRM Analytics REST API 開発者ガイド
jDashboard リソース
- リソース URL
-
1/wave/dashboards/<dashboardIdOrApiName> - 形式
- JSON
- 使用可能なバージョン
- 36.0
- 使用可能なコンポーネント
- HTTP のメソッド
- GET DELETE PATCH
- GET レスポンスボディ (DashboardRepresentation)
-
DashboardRepresentation は、抽象 BaseTemplatedAssetRepresentation からプロパティを継承します。これらの基本プロパティは、DashboardRepresentation に、次のテーブルで明示的に定義されたプロパティとともに表示されます。
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン allowPreview Boolean このダッシュボードがプレビューで使用できるかどうかを示します。 Small、36.0 36.0 currentHistoryId String ダッシュボードに表示する、現在の保存済み履歴。null の場合は、最新のダッシュボードが表示されます。 Small、44.0 44.0 datasets AssetReferenceRepresentation[] このダッシュボードの作成に使用されたデータセットのリスト。 Small、36.0 36.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 mobileDisabled Boolean ダッシュボードがモバイルで無効か否かを示します。 Small、41.0 41.0 refreshDate Date ダッシュボードで使用された最新のデータセットの日付 (ISO8601 日付形式)。 Small、36.0 36.0 state DashboardStateRepresentation ダッシュボードの状態。 Big、36.0 36.0 visibility ConnectWaveAssetVisibilityType アセットが参照アクセス権を持つユーザーに対して非表示になるかどうかを示します。有効な値は、次のとおりです。 - All (すべてのアセットを表示)
- Limited (参照アクセス権を持つ閲覧者にアセットを非表示)
Small、51.0 51.0 - PATCH リクエストボディ (DashboardInputRepresentation)
-
DashboardInputRepresentation は、抽象 BaseAssetInputRepresentation からプロパティを継承します。これらの基本プロパティは、DashboardInputRepresentation に、次のテーブルで明示的に定義されたプロパティとともに表示されます。
パラメーター名 型 説明 必須か省略可能 使用可能なバージョン clonedTemplateOrigin String アセットの複製元が、テンプレートから作成されたアセットであった場合、これは元のアセットのテンプレート作成元です。 省略可能 56.0 currentHistoryId String ダッシュボードに表示する、現在の保存済み履歴 ID。 省略可能 44.0 dateVersion Integer ダッシュボードが使用する日付のバージョン。有効な値は、次のとおりです。 - 1
- 2
省略可能 44.0 folder AssetReferenceInputRepresentation このダッシュボードが保存されているフォルダー。 POST では必須、PATCH では省略可能 44.0 historyLabel String 保存されるダッシュボードバージョンにタグを付ける履歴の表示ラベル。 省略可能 44.0 mobileDisabled Boolean ダッシュボードがモバイルで無効か否かを示します。 省略可能 41.0 state DashboardStateInputRepresentation ダッシュボードの状態。 POST では必須、PATCH では省略可能 36.0 type ConnectWaveAssetTypeEnum アセットタイプ。デフォルトの型は Dashboard です。有効な値は次のとおりです。 - Collection
- Component
- Dashboard
- DashboardSavedView
- DashboardSnapshot
- DataConnector
- Dataflow
- DataflowJob
- DataflowJobNode
- Dataset
- DatasetShard
- DatasetVersion
- ExternalData
- Folder
- Lens
- LightningComponent
- LightningDashboard
- LightningDashboardFolder
- Recipe
- RecipeConfiguration
- RecipeModel
- ReplicatedDataset
- Report
- ReportFolder
- Story
- Widget
- Workflow
省略可能 44.0 xmd XmdInputRepresentation ダッシュボードのアセット XMD。 省略可能 44.0 visibility ConnectWaveAssetVisibilityType アセットが参照アクセス権を持つユーザーに対して非表示になるかどうかを示します。有効な値は、次のとおりです。 - All (すべてのアセットを表示)
- Limited (参照アクセス権を持つ閲覧者にアセットを非表示)
省略可能 51.0 次の JSON は、既存のダッシュボードの説明を編集する方法を示しています。
1{ 2 "description": "This is my dashboard", 3 "label": "Test Dashboard" 4} - PATCH レスポンスボディ (DashboardRepresentation)
-
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン allowPreview Boolean このダッシュボードがプレビューで使用できるかどうかを示します。 Small、36.0 36.0 currentHistoryId String ダッシュボードに表示する、現在の保存済み履歴。null の場合は、最新のダッシュボードが表示されます。 Small、44.0 44.0 datasets AssetReferenceRepresentation[] このダッシュボードの作成に使用されたデータセットのリスト。 Small、36.0 36.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 mobileDisabled Boolean ダッシュボードがモバイルで無効か否かを示します。 Small、41.0 41.0 refreshDate Date ダッシュボードで使用された最新のデータセットの日付 (ISO8601 日付形式)。 Small、36.0 36.0 state DashboardStateRepresentation ダッシュボードの状態。 Big、36.0 36.0 visibility ConnectWaveAssetVisibilityType アセットが参照アクセス権を持つユーザーに対して非表示になるかどうかを示します。有効な値は、次のとおりです。 - All (すべてのアセットを表示)
- Limited (参照アクセス権を持つ閲覧者にアセットを非表示)
Small、51.0 51.0