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

Recipes List リソース

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

リソース URL

1/wave/recipes

形式

JSON

使用可能なバージョン

38.0

HTTP のメソッド

GET POST

GET の要求パラメータ

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

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

1/wave/recipes?q=MyRecipe

GET のレスポンスボディ

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
`recipes`	RecipeRepresentation[]	レシピのリスト。	Small、38.0	38.0

POST リクエストボディ (RecipeInputRepresentation)

プロパティ名	型	説明	必須か省略可能	使用可能なバージョン
`dataflowDefinition`	String	レシピの定義。	省略可能	38.0
`executionEngine`	ConnectRecipeExecutionEngineEnum	レシピの実行エンジン。有効な値は、次のとおりです。 `V1` `V2`	省略可能	41.0
`fileContent`	String	レシピの JSON ファイルの内容 (詳細は wave/recipes/<recipeId>/file を参照)。このプロパティはレシピ UI の内部で使用され、デバッグおよび参照目的でのみ使用できます。この属性は、従来のデータの準備レシピでのみ有効です。	POST と PATCH で必須	38.0
`folder`	AssetReferenceInputRepresentation	レシピを公開する Analytics アプリケーション。	`dataflowDefinition` が存在する場合は必須です。	38.0
`format`	ConnectRecipeFormatTypeEnum	レシピの形式を指定します。有効な値は、次のとおりです。 `R2` (従来のデータの準備) `R3` (データの準備)	省略可能	48.0
`label`	String	レシピの簡単な表示ラベル。	POST では必須、PATCH では省略可能	38.0
`publishingTarget`	ConnectRecipePublishingTargetEnum	レシピの公開先の形式またはシステム。有効な値は、次のとおりです。 `Dataset` (データセットに公開)	省略可能	42.0
`recipeDefinition`	RecipeDefinitionInputRepresentation	データの準備レシピのみを対象とするレシピの定義。これは、従来のデータの準備レシピではサポートされません。	省略可能	49.0
`rowLevelSecurityPredicate`	String	対象データセットのセキュリティ述語。	省略可能	38.0
`schedule`	String	レシピのスケジュールデータフロー実行。	省略可能	38.0

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

1{
2  "label" : "My Data Prep Recipe",
3  "name" : "MyDataPrepRecipe",
4  "format" : "R3",
5  "publishingTarget" : "Dataset",
6  "recipeDefinition" : {
7    "nodes" : { array of node objects },
8    "ui" : { ui metadata object },
9    "version" : "1.0"
10   }              
11}

POST レスポンスボディ (RecipeRepresentation)

RecipeRepresentation は、抽象 BaseWaveAssetRepresentation からプロパティを継承します。これらの基本プロパティは、次のテーブルにある RecipeRepresentation の特定のプロパティとともに表示されます。

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
`dataflowLastUpdate`	Date	前回のレシピのデータフロー更新の日付。	Small、38.0	38.0
`dataset`	AssetReferenceRepresentation	対象データセット。	Small、38.0	38.0
`fileUrl`	String	レシピの JSON ファイルの内容を取得する URL (詳細は /wave/recipes/<recipeId>/file を参照)。	Small、38.0	38.0
`format`	ConnectRecipeFormatTypeEnum	返されるレシピの形式を指定します。有効な値は、次のとおりです。 `R2` (従来のデータの準備) `R3` (データの準備)	Small、48.0	48.0
`nextScheduledDate`	Date	このレシピの次の実行スケジュール。	Small、47.0	47.0
`publishingTarget`	ConnectRecipePublishingTargetEnum	レシピの公開先の形式またはシステム。有効な値は、次のとおりです。 `Dataset` (データセットに公開)	Small、42.0	42.0
`recipeDefinition`	RecipeDefinitionRepresentation	データの準備レシピのみを対象とするレシピの定義。これは、従来のデータの準備レシピではサポートされません。	Small、49.0	49.0
`rowLevelSecurityPredicate`	String	対象データセットのセキュリティ述語。	Small、38.0	38.0
`schedule`	String	現在のデータフローのスケジュール Cron 式。	Small、38.0	38.0
`scheduleType`	ConnectRecipeScheduleTypeEnum	レシピのスケジュールタイプ。有効な値は、次のとおりです。 `EventDriven` `TimeDriven`	Small、49.0	49.0
`sourceRecipe`	String	現在のレシピのアップコンバート元または復元元のレシピ。	Small、50.0	50.0
`targetDataflowId`	String	対象データフロー ID。	Small、42.0	42.0
`validationDetails`	RecipeValidationDetailRepresentation[]	データの準備レシピの検証の詳細のコレクション。これは、従来のデータの準備レシピではサポートされません。	Small、50.0	50.0

RecipeDefinitionInputRepresentation

プロパティ名	型	説明	必須か省略可能	使用可能なバージョン
`name`	String	レシピ定義の名前。	必須	49.0
`nodes`	RecipeDefinitionNodesMap	名前によるレシピノードの対応付け。	必須	49.0
`version`	String	レシピ定義のバージョン。	必須	49.0
`ui`	Object	レシピ定義の UI メタデータ。	必須	49.0

RecipeDefinitionRepresentation

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
`name`	String	レシピ定義の名前。	Small、49.0	49.0
`nodes`	Map<String, Object>	名前によるレシピノードの対応付け。	Small、49.0	49.0
`version`	String	レシピ定義のバージョン。	Small、49.0	49.0
`ui`	Object	レシピ定義の UI メタデータ。	Small、49.0	49.0

RecipeDefinitionNodesMap

プロパティ名	型	説明	必須か省略可能	使用可能なバージョン
`nodes`	Map<String, Object>	名前によるレシピノードの対応付け。	必須	49.0

RecipeValidationDetailRepresentation

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
`message`	String	検証の詳細のメッセージ。	Small、50.0	50.0
`nodeName`	String	検証の詳細で参照されるノードの名前。	Small、50.0	50.0
`nodeType`	String	検証の詳細で参照されるノードの種別。	Small、50.0	50.0
`severity`	ConnectRecipeValidationSeverityEnum	検証の詳細の重要度。有効な値は、次のとおりです。 `Error` - レシピは実行可能および保存可能ではありません。 `Fatal` - 検証プロセスが停止しました。レシピは実行可能および保存可能ではありません。 `Warning` - レシピは実行可能ではありません。	Small、50.0	50.0
`validationAction`	String	検証アクション。	Small、50.0	50.0
`validationCode`	Integer	検証コード。	Small、50.0	50.0

Analytics REST API 開発者ガイド

Recipes List リソース