Analytics REST API 開発者ガイド
jRecipe リソース
- リソース URL
-
1/wave/recipes/<id> - 形式
- JSON
- 使用可能なバージョン
- 38.0
- HTTP のメソッド
- DELETE GET PATCH
- レシピの実行
- データの準備レシピを実行するには、Dataflow Jobs リソース API を使用します。レシピを開始および停止する方法の例については、「データフロージョブまたはレシピの開始と停止」を参照してください。
- レシピをスケジュール
- レシピをスケジュールするには、Schedule Resource API を使用します。レシピをスケジュールする方法の例については、「データフロー、レシピ、データ同期のスケジュール」を参照してください。
- GET の要求パラメータ
-
パラメータ名 型 説明 必須か省略可能 使用可能なバージョン format ConnectRecipeFormatTypeEnum 返されるレシピの形式を指定します。有効な値は、次のとおりです。 - R2 (従来のデータの準備)
- R3 (データの準備)
データの準備レシピでは必須で、従来のデータの準備レシピでは省略可能です。 49.0 次の REST URL は、GET 要求で format 要求パラメータを使用してデータの準備レシピを返す方法を示しています。
1/wave/recipes/<05vS7000000xxxxxxx>?format=R3 - GET レスポンスボディ (RecipeInputRepresentation)
-
��ロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン 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 - PATCH のリクエストボディ
-
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン 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 R3 Recipe", 3 "format" : "R3", 4 "publishingTarget" : "Dataset", 5 "recipeDefinition" : { 6 "nodes" : { array of node objects }, 7 "ui" : { ui metadata object }, 8 "version" : "1.0" 9 } 10} - PATCH レスポンスボディ (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