この文章は 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、PATCH、PUT のレスポンスボディ

レシピ

PATCH のリクエストボディ

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

次の JSON は、レシピ (具体的��はレシピのライセンスの種類) を更新する方法を示します。

1{
2  "recipeObject" : {
3    "licenseAttributes": {
4      "type": "Sonic"
5    }
6  } 
7}

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

メモ

PUT のリクエストボディ

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

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

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

Analytics REST API 開発者ガイド

Recipe リソース