Tableau CRM REST API 開発者ガイド
jRecipes List リソース
- リソース URL
-
1/wave/recipes - 形式
- JSON
- 使用可能なバージョン
- 38.0
- HTTP のメソッド
- GET POST
- GET の要求パラメータ
-
パラメータ名 型 説明 必須か省略可能 使用可能なバージョン page String 生成されたトークン。返されるオブジェクトのビューを示します。 省略可能 38.0 format ConnectRecipeFormatTypeEnum 現在のレシピ定義の形式で絞り込まれたコレクションを返します。有効な値は、次のとおりです。 - R2 (従来のデータプレップ)
- R3 (データプレップ)
省略可能 48.0 licenseType ConnectAnalyticsLicenseTypeEnum Tableau CRM ライセンスの種類。有効な値は、次のとおりです。 - EinsteinAnalytics
- Sonic
省略可能 52.0 pageSize Int 1 ページで返される項目の数。最小値は 1、最大値は 200、デフォルトは 25 です。 省略可能 38.0 q String 検索語。各用語はスペースで区切られます。ワイルドカードは、クエリ文字列の最後のトークンに自動的に付加されます。ユーザの検索クエリに疑問符またはワイルドカードが含まれている場合、それらの記号は URI で他の特殊文字と同様にクエリ文字列から自動的に削除されます。 省略可能 38.0 sort ConnectWaveSortOrderTypeEnum 返されたコレクションに適用される並び替え順の種別。有効な値は、次のとおりです。 - CreatedBy
- CreatedDate
- LastModified
- LastQueried
- LastRefreshed
- Mru (Most Recently Used、最後に参照した日付)
- Name
- TotalRows
省略可能 38.0 次の REST URL は、GET 要求で q パラメータを検索クエリとして使用する方法を示しています。
1/wave/recipes?q=MyRecipe - GET のレスポンスボディ
-
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン nextPageUrl String コレクションのコンテンツの次のページを取得する URL。 Small、52.0 52.0 recipes RecipeRepresentation[] レシピのリスト。 Small、38.0 38.0 totalSize Integer コレクションの要素の合計数 (すべてのページを含む)。 Medium、52.0 52.0 url String コレクションを取得する URL。 Small、52.0 52.0 - POST リクエストボディ (RecipeInputRepresentation)
-
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン conversionDetails RecipeConversionDetailRepresentation[] 保存されている R3 へとレシピを変換するときの変換の詳細のリスト。 Small、51.0 51.0 dataflowDefinition String レシピの定義。 省略可能 38.0 executionEngine ConnectRecipeExecutionEngineEnum レシピの実行エンジン。有効な値は、次のとおりです。 - V1
- V2
省略可能 41.0 fileContent String レシピの JSON ファイルの内容 (詳細は wave/recipes/<recipeId>/file を参照)。このプロパティはレシピ UI の内部で使用され、デバッグおよび参照目的でのみ使用できます。このプロパティは、従来のデータプレップレシピでのみ有効です。 POST と PATCH で必須 38.0 folder AssetReferenceInputRepresentation レシピを公開する Tableau CRM アプリケーション。 dataflowDefinition が存在する場合は必須です。 38.0 format ConnectRecipeFormatTypeEnum レシピの形式を指定します。有効な値は、次のとおりです。 - R2 (従来のデータプレップ)
- R3 (データプレップ)
省略可能 48.0 historyLabel String レシピのバージョンにタグを付ける履歴の表示ラベル。 省略可能 51.0 label String レシピの簡単な表示ラベル。 POST では必須、PATCH では省略可能 38.0 licenseAttributes LicensesAttributesRepresentation Tableau CRM ライセンスの種類とその他のプロパティ。 省略可能 51.0 publishingTarget ConnectRecipePublishingTargetEnum レシピの公開先の形式またはシステム。有効な値は、次のとおりです。 - Dataset (データセットに公開)
省略可能 42.0 recipeDefinition RecipeDefinitionInputRepresentation データプレップレシピのみを対象とするレシピの定義。このプロパティは、従来のデータプレップレシピではサポートされません。 省略可能 49.0 rowLevelSecurityPredicate String 取得先データセットのセキュリティ述語。 省略可能 38.0 schedule String レシピのスケジュールデータフロー実行。 省略可能 38.0 sourceDataflow AssetReferenceInputRepresentation R3 のレシピにアップコンバートするために使用される取得元データフローアセット。 省略可能 51.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 の特定のプロパティとともに表示されます。
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン 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 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 - RecipeDefinitionInputRepresentation
-
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン name String レシピ定義の名前。 必須 49.0 nodes Map<String, RecipeNodeInputRepresentation> 名前によるレシピノードの対応付け。 必須 49.0 version String レシピ定義のバージョン。 必須 49.0 ui Object レシピ定義の UI メタデータ。 必須 49.0 - RecipeDefinitionRepresentation
-
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン name String レシピ定義の名前。 Small、49.0 49.0 nodes Map<String, RecipeNodeRepresentation> 名前によるレシピノードの対応付け。 Small、51.0 51.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 - RecipeConversionDetailRepresentation
-
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン conversionDetailId Integer 変換の詳細 ID。 Small、52.0 52.0 message String 変換の詳細メッセージ。 Small、52.0 52.0 nodeName String 変換の詳細で参照されるノードの名前。 Small、52.0 52.0 severity ConnectRecipeConversionSeverityEnum 変換の詳細の重大度。有効な値は、次のとおりです。 - UserInfo - ユーザの注意が必要な変換の詳細。
- Warning - ユーザによる更新が必要な変換の警告。
Small、52.0 52.0 - RecipeConversionDetailInputRepresentation
-
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン conversionDetailId Integer 変換の詳細 ID。 必須 52.0 message String 変換の詳細メッセージ。 必須 52.0 nodeName String 変換の詳細で参照されるノードの名前。 必須 52.0 severity ConnectRecipeConversionSeverityEnum 変換の詳細の重大度。有効な値は、次のとおりです。 - UserInfo - ユーザの注意が必要な変換の詳細。
- Warning - ユーザによる更新が必要な変換の警告。
Small、52.0 52.0