Tableau CRM REST API 開発者ガイド
jDatasets List リソース
- リソース URL
-
1/wave/datasets - 形式
- JSON
- 使用可能なバージョン
- GET 36.0 POST 50.0
- 使用可能なコンポーネント
- HTTP のメソッド
- GET POST
- GET の要求パラメータ
-
パラメータ名 型 説明 必須か省略可能 使用可能なバージョン datasetTypes ConnectWaveDatasetTypeEnum データセットの種別。有効な値は、次のとおりです。 - Default
- Live
- StagedData
- Trended
省略可能 50.0 folderId ID 特定のフォルダの内容のみが含まれるように結果を絞り込みます。要求ユーザの非公開フォルダにある項目のユーザ ID などになります。 省略可能 36.0 hasCurrentOnly Boolean 現在のバージョンのデータセットのみが含まれるようにデータセットのリストを絞り込むか (true)、否か (false) を示します。デフォルトは false です。 省略可能 52.0 ids ID[] 指定された ID を持つデータセットのみが含まれるようにデータセットのリストを絞り込みます。 省略可能 53.0 includeCurrentVersion Boolean コレクションに現在のデータセットバージョンのメタデータを含めるか (true)、否か (false) を示します。デフォルトは false です。 省略可能 52.0 licenseType ConnectAnalyticsLicenseTypeEnum コレクションを Analytics ライセンスの種類で絞り込みます。有効な値は、次のとおりです。 - EinsteinAnalytics (Tableau CRM)
- Sonic (Salesforce データパイプライン)
省略可能 52.0 order Enum 結果に適用される順序。有効な値は、次のとおりです。 - Ascending
- Descending
省略可能 42.0 page String 生成されたトークン。返されるデータセットのビューを示します。 省略可能 36.0 pageSize Int 1 ページで返される項目の数。最小値は 1、最大値は 200、デフォルトは 25 です。 省略可能 36.0 q String 検索語。各用語はスペースで区切られます。ワイルドカードは、クエリ文字列の最後のトークンに自動的に付加されます。ユーザの検索クエリに疑問符またはワイルドカードが含まれている場合、それらの記号は URI で他の特殊文字と同様にクエリ文字列から自動的に削除されます。 省略可能 36.0 scope ConnectWaveScopeTypeEnum 返されたコレクションに適用される範囲の種別。有効な値は、次のとおりです。 - CreatedByMe
- Mru (最近使用)
- SharedWithMe
省略可能 38.0 sort ConnectWaveDatasetSortOrderTypeEnum 返されたコレクションに適用される並び替え順の種別。有効な値は、次のとおりです。 - CreatedBy
- CreatedDate
- LastModified
- LastQueried
- LastRefreshed
- Mru (Most Recently Used、最後に参照した日付)
- Name
- TotalRows
省略可能 38.0 supportsNewDates Boolean 新しい日付をサポートするデータセットのみが含まれるようにデータセットのリストを絞り込むか (true)、否か (false) を示します。デフォルトは false です。 省略可能 52.0 hasCurrentOnly パラメータを使用して、現在のデータセットバージョンが定義されているデータセットのみが含まれるように結果を絞り込むことができます。また、filterGroup パラメータを使用して、現在のデータセットバージョンが定義されているデータセットに関する補足情報を要求することもできます。たとえば、次の GET 要求ではこれらのパラメータが設定されています。この要求では、データセットのリストが絞り込まれ、次の補足項目が出力表示に追加されます。1/wave/datasets?hasCurrentOnly=true&filterGroup=Supplemental- currentVersionCreatedBy
- currentVersionCreatedDate
- currentVersionLastModifiedBy
- currentVersionLastModifiedDate
- GET のレスポンスボディ
-
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン datasets DatasetRepresentation[] 現在のユーザが使用できるデータセットのリスト。 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 リクエストボディ (DatasetInputRepresentation)
-
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン currentVersionId ID 廃止 このデータセットの現在のバージョンの 18 文字の ID。 省略可能 36.0 ～ 40.0 datasetType ConnectWaveDatasetTypeEnum データセットの種別。有効な値は、次のとおりです。 - Default
- Live
- StagedData
- Trended
必須 50.0 folder ID データセットが含まれるフォルダの 18 文字の ID。 省略可能 36.0 liveConnection LiveConnectionInputRepresentation データセットのライブ接続の詳細。 省略可能 50.0 userXmd XmdInputRepresentation このデータセットに関連付けられたユーザ XMD。 省略可能 39.0 visibility ConnectWaveAssetVisibilityType アセットが参照アクセス権を持つユーザに対して非表示になるかどうかを示します。有効な値は、次のとおりです。 - All (すべてのアセットを表示)
- Limited (参照アクセス権を持つ閲覧者にアセットを非表示)
省略可能 51.0 - POST レスポンスボディ (DatasetRepresentation)
-
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン clientShardsUrl String データセットシャードの URL。 Small、36.0 36.0 currentVersionCreatedBy WaveUserRepresentation 現在のバージョンのデータセットの作成者。filterGroup 入力パラメータが Supplemental に設定されている場合にのみ返されます。 Supplemental、36.0 36.0 currentVersionCreatedDate Date 現在のバージョンのデータセットが作成された時刻 (ISO8601 日付形式)。filterGroup 入力パラメータが Supplemental に設定されている場合にのみ返されます。 Supplemental、36.0 36.0 currentVersionId ID 現在のデータセットバージョンの 18 文字の ID。 Small、36.0 36.0 currentVersionLastModifiedBy WaveUserRepresentation 現在のバージョンのデータセットを最後に更新したユーザ。filterGroup 入力パラメータが Supplemental に設定されている場合にのみ返されます。 Supplemental、36.0 36.0 currentVersionLastModifiedDate Date 現在のバージョンのデータセットが最後に変更された時刻 (ISO8601 日付形式)。filterGroup 入力パラメータが Supplemental に設定されている場合にのみ返されます。 Supplemental、36.0 36.0 currentVersionSupportsNewDates Boolean 現在のバージョンのデータセットが新しい日付形式をサポートしているか (true)、否か (false) を示します。 Supplemental、52.0 52.0 currentVersionTotalRows Integer データセット内の行の合計数。 Supplemental、42.0 42.0 ～ 52.0 currentVersionTotalRowCount Integer データセット内の行の合計数。 Small、53.0 53.0 currentVersionUrl String 現在のデータセットバージョンの URL。 Small、36.0 36.0 dataRefreshDate Date このデータセットが最後に更新された時刻。 Small、40.0 40.0 datasetType ConnectWaveDatasetTypeEnum データセットの種別。有効な値は、次のとおりです。 - Default
- Live
- StagedData
- Trended
Small、41.0 41.0 folder AssetReferenceRepresentation このデータセットが保存されているフォルダへの参照。 Small、36.0 36.0 lastMetadataChangedDate Date このデータセットのメタデータ (フォルダ、表示ラベル、現在、共有、またはセキュリティ述語) が最後に変更された時刻。 Small、51.0 51.0 lastQueriedDate Date このデータセットが最後に照会された時刻。 Small、39.0 39.0 licenseAttributes LicenseAttributes このデータセットに関連付けられた Analytics ライセンス属性。 Small、52.0 52.0 liveConnection LiveConnectionRepresentation データセットのライブ接続の詳細。 Small、50.0 50.0 userXmd XmdRepresentation 関連付けられたユーザ XMD。 Medium、36.0 36.0 versionsUrl String データセットバージョンの URL。 Small、36.0 36.0 visibility ConnectWaveAssetVisibilityType アセットが参照アクセス権を持つユーザに対して非表示になるかどうかを示します。有効な値は、次のとおりです。 - All (すべてのアセットを表示)
- Limited (参照アクセス権を持つ閲覧者にアセットを非表示)
Small、51.0 51.0