この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

Datasets List リソース

Analytics データセットのリストを返します。

hasCurrentOnly パラメータを使用して、現在のデータセットバージョンが定義されているデータセットのみが含まれるように結果を絞り込むことができます。また、filterGroup パラメータを使用して、現在のデータセットバージョンが定義されているデータセットに関する補足情報を要求することもできます。たとえば、次の GET 要求ではこれらのパラメータが設定されています。

1/wave/datasets?hasCurrentOnly=true&filterGroup=Supplemental

この要求では、データセットのリストが絞り込まれ、次の補足項目が出力表示に追加されます。

currentVersionCreatedBy
currentVersionCreatedDate
currentVersionLastModifiedBy
currentVersionLastModifiedDate

filterGroup パラメータについての詳細は、『Chatter REST API 開発者ガイド』の「応答サイズの指定」を参照してください。

リソース URL

1/wave/datasets

形式

JSON

使用可能なバージョン

36.0

HTTP のメソッド

GET

GET の要求パラメータ

パラメータ名	型	説明	必須か省略可能	使用可能なバージョン
`folderId`	ID	特定のフォルダのコンテンツのみが含まれるように結果を絞り込みます。要求ユーザの非公開フォルダの項目のユーザ ID などになります。	省略可能	36.0
`hasCurrentOnly`	Boolean	現在のバージョンのデータセットのみが含まれるようにデータセットのリストを絞り込みます。デフォルトは、`false` です。	省略可能	36.0
`order`	Enum	結果に適用される順序。値は次のとおりです。 `Ascending` `Descending`	省略可能	42.0
`page`	String	生成されたトークン。返されるデータセットのビューを示します。	省略可能	36.0
`pageSize`	Int	1 ページで返される項目の数。最小値は 1、最大値は 200、デフォルトは 25 です。	省略可能	36.0
`q`	String	検索語。各用語はスペースで区切られます。ワイルドカードはサポートされていません。	省略可能	36.0
`scope`	Enum	コレクションリソースの表現に適用される範囲の種別。 `CreatedByMe` `IncludeAllPrivate`: 他のユーザの非公開フォルダを含む `SharedWithMe`		41.0
`sort`	Enum	並び替えできるプロパティ名。値は次のとおりです。 `CreatedBy` `CreatedDate` `LastModified` `LastQueried` `LastRefreshed` `Mru`: Most recently used (最後に参照した日付) `Name` `TotalRows` デフォルト値は、`Mru` です。	省略可能	42.0

GET のレスポンスボディ

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
`datasets`	Dataset Resource[]	現在のユーザが使用できるデータセットのリスト。	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

レスポンスボディの例

1{
2  "datasets" : [ "/* Datasets detail omitted for brevity. */" ],
3  "nextPageUrl" : "/services/data/v36.0/wave/datasets?page=eyJwYWdlU2l6ZSI6MjUsInNv",
4  "totalSize" : 33,
5  "url" : "/services/data/v36.0/wave/datasets"
6}

Analytics REST API 開発者ガイド

Datasets List リソース