CRM Analytics REST API 開発者ガイド
jDashboards List リソース
- リソース URL
-
1/wave/dashboards - 形式
- JSON
- 使用可能なバージョン
- 36.0
- 使用可能なコンポーネント
-
- Aura — <wave:sdk> listDashboards()
- HTTP のメソッド
- GET POST
- GET の要求パラメータ
-
パラメータ名 型 説明 必須か省略可能 使用可能なバージョン folderId ID 特定のフォルダの内容のみが含まれるように結果を絞り込みます。要求ユーザの非公開フォルダにある項目のユーザ ID などになります。 省略可能 36.0 ids String 指定された ID を持つダッシュボードのみが含まれるように結果を絞り込みます。 省略可能 52.0 mobileOnly Boolean モバイル対応ダッシュボードのみの結果を絞り込みます。 省略可能 41.0 page String 生成されたトークン。返されるダッシュボードのビューを示します。 省略可能 36.0 pageSize Integer 1 ページで返される項目の数。最小値は 1、最大値は 200、デフォルトは 25 です。 省略可能 36.0 q String 検索語。各用語はスペースで区切られます。ワイルドカードは、クエリ文字列の最後のトークンに自動的に付加されます。ユーザの検索クエリに疑問符またはワイルドカードが含まれている場合、それらの記号は URI で他の特殊文字と同様にクエリ文字列から自動的に削除されます。 省略可能 36.0 scope ConnectWaveScopeTypeEnum 返されたコレクションに適用される範囲の種別。有効な値は、次のとおりです。 - CreatedByMe
- Mru (最近使用)
- SharedWithMe
省略可能 38.0 sort ConnectWaveSortOrderTypeEnum 返されたコレクションに適用される並び替え順の種別。有効な値は、次のとおりです。 - App
- CreatedBy
- CreatedDate
- LastModified
- LastModifiedBy
- Mru (Most Recently Used、最後に参照した日付)
- Name
- Type
省略可能 38.0 templateApiName String 特定のアプリケーションテンプレートから作成されたダッシュボードのコレクションのみを含めるように結果を絞り込みます。 省略可能 38.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
Optional、Small、36.0 36.0 - GET のレスポンスボディ
-
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン dashboards DashboardRepresentation[] Analytics ダッシュボードのコレクション。 Small、36.0 36.0 nextPageUrl String コレクションのコンテンツの次のページを取得する URL。 Small、36.0 36.0 totalSize Integer コレクションの要素の合計数 (すべてのページを含む)。 Medium、36.0 36.0 url String コレクションを取得する URL。 Small、36.0 36.0 - POST リクエストボディ (DashboardInputRepresentation)
-
DashboardInputRepresentation は、抽象 BaseAssetInputRepresentation からプロパティを継承します。これらの基本プロパティは、DashboardInputRepresentation に、次のテーブルで明示的に定義されたプロパティとともに表示されます。
パラメータ名 型 説明 必須か省略可能 使用可能なバージョン 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 - POST レスポンスボディ (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