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

Recipes List リソース

データプレップレシピのコレクションを返して、レシピを作成します。

リソース URL

1/wave/recipes

形式

JSON

使用可能なバージョン

38.0

使用可能なコンポーネント

LWC — lightning/analyticsWaveApi getRecipes()

HTTP のメソッド

GET POST

GET の要求パラメータ

パラメータ名	型	説明	必須か省略可能	使用可能なバージョン
`page`	String	生成されたトークン。返されるオブジェクトのビューを示します。	省略可能	38.0
`format`	ConnectRecipeFormatTypeEnum	現在のレシピ定義の形式で絞り込まれたコレクションを返します。有効な値は、次のとおりです。 `R2` (従来のデータプレップ) `R3` (データプレップ)	省略可能	48.0
`licenseType`	ConnectAnalyticsLicenseTypeEnum	コレクションを Analytics ライセンスの種類で絞り込みます。有効な値は、次のとおりです。 `EinsteinAnalytics` (Tableau CRM) `Sonic` (Salesforce データパイプライン)	省略可能	52.0
`pageSize`	Int	1 ページで返される項目の数。最小値は 1、最大値は 200、デフォルトは 25 です。	省略可能	38.0
`q`	String	検索語。各用語はスペースで区切られます。ワイルドカードは、クエリ文字列の最後のトークンに自動的に付加されます。ユーザの検索クエリに疑問符またはワイルドカードが含まれている場合、それらの記号は URI で他の特殊文字と同様にクエリ文字列から自動的に削除されます。	省略可能	38.0
`sort`	ConnectWaveSortOrderTypeEnum	返されたコレクションに適用される並び替え順の種別。有効な値は、次のとおりです。 `App` `CreatedBy` `CreatedDate` `LastModified` `LastModifiedBy` `Mru` (Most Recently Used、最後に参照した日付) `Name` `Type`	省略可能	38.0

次の REST URL は、GET 要求で q パラメータを検索クエリとして使用する方法を示しています。

1/wave/recipes?q=MyRecipe

GET のレスポンスボディ

Recipe Collection

POST のリクエストボディ

プロパティ名	型	説明	必須か省略可能	使用可能なバージョン
`enableEditorValidation`	Boolean	レシピのエディタ検証が有効化されているか (`true`)、否か (`false`) を示します。	必須	53.0
`recipeFile`	Binary	レシピファイル。	必須	38.0
`recipeObject`	RecipeInput[]	レシピ定義。	必須	38.0
`validationContext`	ConnectRecipeValidationContextEnum	レシピ検証のコンテキスト。有効な値は、次のとおりです。 `Default` `Editor`	必須	53.0

次の JSON は、レシピを作成する方法を示しています。

1{
2    "recipeDefinition" : {
3        "name" : "MyDataPrepRecipe",
4        "nodes" : { array of node objects },
5        "ui" : { ui metadata object },
6        "version" : "1.0"
7    }              
8}

POST のレスポンスボディ

レシピ

Tableau CRM REST API 開発者ガイド

Recipes List リソース