Analytics REST API 開発者ガイド
jFolders List リソース
Analytics データセット、レンズ、ダッシュボードが含まれるフォルダである Analytics アプリケーションを作成 (POST) するか、アプリケーションまたはフォルダのコレクションを返します (GET)。
- リソース URL
-
1/wave/folders - 形式
- JSON
- 使用可能なバージョン
- 36.0
- HTTP のメソッド
- GET と POST
- GET の要求パラメータ
-
パラメータ名 型 説明 必須か省略可能 使用可能なバージョン isPinned Boolean 36.0 mobileOnlyFeaturedAssets Boolean このパラメータを true に設定すると、Einstein Analytics モバイルアプリケーションで有効になっているダッシュボードのみが表示されます。 省略可能 43.0 page String 生成されたトークン。返されるフォルダのビューを示します。 省略可能 36.0 pageSize Int 1 ページで返される項目の数。最小値は 1、最大値は 200、デフォルトは 25 です。 省略可能 36.0 q String 検索語。各用語はスペースで区切られます。ワイルドカードはサポートされていません。 省略可能 36.0 scope Enum コレクションリソースの表現に適用される範囲の種別 (CreatedByMe または SharedWithMe) 41.0 sort String 結果の並び替え順。値は次のとおりです。 - LastModified
- Mru: Most recently used (最後に参照した日付)
- Name
デフォルトは、Mru です。
省略可能 36.0 templateSourceId String 36.0 - GET のレスポンスボディ
-
WaveFolderCollectionRepresentation
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン folders Wave Folder[] フォルダまたはアプリケーションのリスト。 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 のリクエストボディ
-
WaveFolderInputRepresentation
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン applicationStatus ConnectWaveApplicationStatusEnum アプリケーションの作成状況 (CancelledStatus、CompletedStatus、DataflowInProgressStatus、FailedStatus、InProgressStatus、NewStatus)。 36.0 assetIcon String 新規フォルダまたはアプリケーションを最適に表すアイコンの列挙。有効な値は 1.png から 20.png です。 36.0 attachedFiles AssetReferenceInputRepresentation[] 添付ファイル ID リスト 39.0 canBeSharedExternally Boolean アプリケーションをコミュニティで共有するかどうか 37.0 defaultAsset AssetReferenceInputRepresentation アプリケーションランタイムにおいてデフォルトでこのアプリケーションに提示される、レンズまたはダッシュボードの ID。 37.0 description String 新規フォルダまたはアプリケーションの説明。 36.0 featuredAssets Map (FeaturedAssetsInputRepresentation) このアプリケーションで UI に使用する主要アセット。 39.0 isPinned Boolean アプリケーションが固定表示フォルダであるかどうか。 39.0 label String 新規フォルダまたはアプリケーションの、ユーザに表示される名前。 36.0 name String 新規フォルダまたはアプリケーションの内部 API 参照名。 36.0 shares WaveFolderShareInputRepresentation[] フォルダ共有ルール。 36.0 - POST のレスポンスボディ
-
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン applicationStatus ConnectWaveApplicationStatusEnum アプリケーションの作成状況 (CancelledStatus、CompletedStatus、DataflowInProgressStatus、FailedStatus、InProgressStatus、NewStatus)。 Medium、36.0 36.0 attachedFiles AssetReferenceRepresentation[] インサイトフォルダに添付されるファイルの ID Big、39.0 39.0 canBeSharedExternally Boolean このアプリケーションをコミュニティユーザと共有できるかどうか。 Big、37.0 37.0 defaultAsset AssetReferenceRepresentation アプリケーションを AppRuntime モードで表示するときに表示されるデフォルトアセット (レンズ/ダッシュボード)。 Big、37.0 37.0 featuredAssets Map (FeaturedAssetsRepresentation) このアプリケーションで UI に使用する主要アセット。 Big、39.0 39.0 icon AssetReferenceRepresentation アセットアイコン。 Small、36.0 36.0 isPinned Boolean このアプリケーションが固定されているかどうか。 Small、39.0 39.0 shares WaveFolderShareRepresentation[] フォルダ共有リスト。 Big、36.0 36.0 templateOptions TemplateOptionsRepresentation テンプレート Analytics アプリケーションで最後に実行されたアクションで使用されたオプション。 Big、37.0 37.0 templateSourceId String フォルダまたはアプリケーションの作成に使用されるソーステンプレート ID または API 名。 Medium、36.0 36.0 templateValues Map (Object) フォルダまたはアプリケーションの作成か更新に使用されたテンプレート値 (該当する場合)。 Big、37.0 37.0 templateVersion String このアプリケーションの作成元であるテンプレートのバージョン。 Medium、37.0 37.0 assetSharingUrl String このアセットを Analytics Builder で開くための URL。ディープリンクの形式です。サーバは、urlType、assetId、orgId、loginHost を含む可能性があるリンクパラメータ、およびその他の省略可能パラメータを調べて、必要に応じて変換して対象クライアントで正しい結果を生成します。たとえば、Analytics ダッシュボードがデスクトップクライアントで開き、モバイル OS を使用している場合はモバイルで開きます。たとえば、次のような共有 URL があるとします。 この場合は、次のような Web URL が生成されます。1http://{host}/analytics/application/005xx000001SvSwAAK?urlType=sharing&orgId=00DT0000000Dpvc&loginHost=https%3A%2F%2Ftest.my.salesforce.comiOS では、次のような URL が生成されることがあります。1http://{host}/insights/web/explore.apexp#application/005xx000001SvSwAAK1com.salesforce.kona://application/005xx000001SvSwAAK&orgId=00DT0000000Dpvc&loginHost=https%3A%2F%2Ftest.my.salesforce.comSmall、36.0 36.0 createdBy WaveUserRepresentation アセット作成者。 Small、36.0 36.0 createdDate Date アセットが作成された時刻。 Small、36.0 36.0 description String アセットの簡単な説明。 Small、36.0 36.0 id String 18 文字のアセット ID。 Small、36.0 36.0 label String アセットの表示ラベル。 Small、36.0 36.0 lastAccessedDate Date アセットが最後にアクセスされた時刻。 Small、36.0 36.0 lastModifiedBy WaveUserRepresentation アセットを最後に更新したユーザ。 Small、36.0 36.0 lastModifiedDate Date アセットが最後に変更された時刻。 Small、36.0 36.0 name String アセットの名前。 Small、36.0 36.0 namespace String アセットの名前空間。 Small、36.0 36.0 permissions PermissionsRepresentation 現在のユーザの権限を表します。 Small、36.0 36.0 type ConnectWaveAssetTypeEnum アセットタイプ。値は次のとおりです。 - Dashboard
- DataConnector
- Dataflow
- Dataset
- DatasetShard (internal)
- DatasetVersion
- ExternalData
- Folder
- Lens
- Recipe
- ReplicatedDataset
- Workflow
Small、36.0 36.0 url String アセットの定義を取得するための URL。 Small、36.0 36.0