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

Recipe リソース

データプレップレシピを返したり、更新や削除したりします。

リソース URL

1/wave/recipes/<id>

形式

JSON

使用可能なバージョン

38.0

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

LWC — lightning/analyticsWaveApi deleteRecipe()
LWC — lightning/analyticsWaveApi getRecipe()

HTTP のメソッド

DELETE GET PATCH PUT

レシピの実行: データプレップレシピを実行するには、Dataflow Jobs リソース API を使用します。レシピを開始および停止する方法の例については、「データフロージョブまたはレシピの開始と停止」を参照してください。

レシピをスケジュール: レシピをスケジュールするには、Schedule Resource API を使用します。レシピをスケジュールする方法の例については、「データフロー、レシピ、データ同期のスケジュール」を参照してください。

GET の要求パラメータ

パラメータ名	型	説明	必須か省略可能	使用可能なバージョン
`format`	ConnectRecipeFormatTypeEnum	返されるレシピの形式を指定します。有効な値は、次のとおりです。 `R2` (従来のデータプレップ) `R3` (データプレップ)	データプレップレシピでは必須で、従来のデータプレップレシピでは省略可能です。	49.0
`historyId`	Id	履歴 ID を使用して、特定のレシピバージョンを要求します。	省略可能	51.0

次の REST URL は、GET 要求で format 要求パラメータを使用してデータプレップレシピを返す方法を示しています。

1/wave/recipes/<05vS7000000xxxxxxx>?format=R3

API バージョン 49.0 以上を使用する場合、データプレップ形式で作成するレシピでは format 要求パラメータが必要です。従来のデータプレップ形式で作成するレシピでは、format 要求パラメータは必要ではありません。従来のデータプレップレシピ形式をデータプレップレシピ形式にアップコンバートする場合、R3 に設定した format 要求パラメータを使用します。

メモ

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

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
`conversionDetails`	RecipeConversionDetailRepresentation[]	レシピを `R3` に変換するときのアップコンバートの詳細のリスト。	Small、51.0	51.0
`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
`historiesUrl`	String	レシピに関連付けられたバージョン履歴の URL。	Small、51.0	51.0
`licenseType`	ConnectAnalyticsLicenseTypeEnum	Tableau CRM ライセンスの種類。有効な値は、次のとおりです。 `EinsteinAnalytics` `Sonic`	省略可能	51.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
`scheduleAttributes`	ScheduleRepresentation	��シピのスケジュール。	Small、53.0	53.0
`scheduleType`	ConnectRecipeScheduleTypeEnum	レシピのスケジュールタイプ。有効な値は、次のとおりです。 `EventDriven` `TimeDriven`	Small、49.0	49.0
`sourceDataflow`	String	現在のレシピをアップコンバートまたは戻すために使用されるデータフロー。	Small、v51.0	51.0
`sourceRecipe`	String	現在のレシピをアップコンバートまたは戻すために使用されるレシピ。	Small、50.0	50.0
`targetDataflowId`	String	取得先データフロー ID。	Small、42.0	42.0
`validationDetails`	RecipeValidationDetailRepresentation[]	データプレップレシピの検証の詳細のコレクション。このプロパティは、従来のデータプレップレシピではサポートされません。	Small、50.0	50.0

PATCH のリクエストボディ

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

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

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

従来のデータプレップ形式で作成したレシピをデータプレップ形式で取得する場合、データプレップ形式を使用する PATCH 要求でレシピをデータプレップ形式に永久にアップコンバートします。

メモ

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

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
`conversionDetails`	RecipeConversionDetailRepresentation[]	レシピを `R3` に変換するときのアップコンバートの詳細のリスト。	Small、51.0	51.0
`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
`historiesUrl`	String	レシピに関連付けられたバージョン履歴の URL。	Small、51.0	51.0
`licenseType`	ConnectAnalyticsLicenseTypeEnum	Tableau CRM ライセンスの種類。有効な値は、次のとおりです。 `EinsteinAnalytics` `Sonic`	省略可能	51.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
`scheduleAttributes`	ScheduleRepresentation	レシピのスケジュール。	Small、53.0	53.0
`scheduleType`	ConnectRecipeScheduleTypeEnum	レシピのスケジュールタイプ。有効な値は、次のとおりです。 `EventDriven` `TimeDriven`	Small、49.0	49.0
`sourceDataflow`	String	現在のレシピをアップコンバートまたは戻すために使用されるデータフロー。	Small、v51.0	51.0
`sourceRecipe`	String	現在のレシピをアップコンバートまたは戻すために使用されるレシピ。	Small、50.0	50.0
`targetDataflowId`	String	取得先データフロー ID。	Small、42.0	42.0
`validationDetails`	RecipeValidationDetailRepresentation[]	データプレップレシピの検証の詳細のコレクション。このプロパティは、従来のデータプレップレシピではサポートされません。	Small、50.0	50.0

PUT リクエストボディ (AssetRevertHistoryInputRepresentation)

PUT API 要求を使用して、前の履歴バージョンに戻します。

プロパティ名	型	説明	必須か省略可能	使用可能なバージョン
`historyId`	String	このアセットを元に戻すために必要な取得元履歴 ID。	必須	42.0
`historyLabel`	String	元に戻す変更にタグを付ける履歴の表示ラベル。	省略可能	42.0

次の JSON は、レシピバージョンを元に戻す要求を示しています。

1{
2                "historyId" : "0RmRM000000xxxxxxx"
3                }

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

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

プロパティ名	型	説明	検索条件グループとバージョン	使用可能なバージョン
`conversionDetails`	RecipeConversionDetailRepresentation[]	レシピを `R3` に変換するときのアップコンバートの詳細のリスト。	Small、51.0	51.0
`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
`historiesUrl`	String	レシピに関連付けられたバージョン履歴の URL。	Small、51.0	51.0
`licenseType`	ConnectAnalyticsLicenseTypeEnum	Tableau CRM ライセンスの種類。有効な値は、次のとおりです。 `EinsteinAnalytics` `Sonic`	省略可能	51.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
`scheduleAttributes`	ScheduleRepresentation	レシピのスケジュール。	Small、53.0	53.0
`scheduleType`	ConnectRecipeScheduleTypeEnum	レシピのスケジュールタイプ。有効な値は、次のとおりです。 `EventDriven` `TimeDriven`	Small、49.0	49.0
`sourceDataflow`	String	現在のレシピをアップコンバートまたは戻すために使用されるデータフロー。	Small、v51.0	51.0
`sourceRecipe`	String	現在のレシピをアップコンバートまたは戻すために使用されるレシピ。	Small、50.0	50.0
`targetDataflowId`	String	取得先データフロー ID。	Small、42.0	42.0
`validationDetails`	RecipeValidationDetailRepresentation[]	データプレップレシピの検証の詳細のコレクション。このプロパティは、従来のデータプレップレシピではサポートされません。	Small、50.0	50.0

Tableau CRM REST API 開発者ガイド

Recipe リソース