Analytics REST API 開発者ガイド
jRecipes List リソース
- リソース URL
-
1/wave/recipes - 形式
- JSON
- 使用可能なバージョン
- 38.0
- HTTP のメソッド
- GET POST
- GET の要求パラメータ
-
パラメータ名 型 説明 必須か省略可能 使用可能なバージョン page String 生成されたトークン。返されるオブジェクトのビューを示します。 省略可能 38.0 format ConnectRecipeFormatTypeEnum 現在のレシピ定義の形式。有効な値は、次のとおりです。 - R2 (レシピ 2.0)
- R3 (レシピ 3.0)
省略可能 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 の内部で使用され、デバッグおよび参照目的でのみ使用できます。この属性は、���シピバージョン 1.0 および 2.0 でのみ有効です。 POST と PATCH で必須 38.0 folder AssetReferenceInputRepresentation レシピを公開する Analytics アプリケーション。 dataflowDefinition が存在する場合は必須です。 38.0 format ConnectRecipeFormatTypeEnum 現在のレシピ定義の形式。有効な値は、次のとおりです。 - R2 (レシピ 2.0)
- R3 (レシピ 3.0)
省略可能 48.0 label String レシピの簡単な表示ラベル。 POST では必須、PATCH では省略可能 38.0 publishingTarget ConnectRecipePublishingTargetEnum レシピの公開先の形式またはシステム。有効な値は、次のとおりです。 - Dataset (データセットに公開)
省略可能 42.0 rowLevelSecurityPredicate String 対象データセットのセキュリティ述語。 省略可能 38.0 schedule String レシピのスケジュールデータフロー実行。 省略可能 38.0 次の JSON は、レシピを作成する方法を示しています。
1{ 2 "label" : "My New Recipe", 3 "fileContent" : "" 4} - 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 (レシピ 2.0)
- R3 (レシピ 3.0)
Small、48.0 48.0 nextScheduledDate Date このレシピの次の実行スケジュール。 Small、47.0 47.0 publishingTarget ConnectRecipePublishingTargetEnum レシピの公開先の形式またはシステム。有効な値は、次のとおりです。 - Dataset (データセットに公開)
Small、42.0 42.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 targetDataflowId String 対象データフロー ID。 Small、42.0 42.0