Analytics REST API 開発者ガイド
jDataflow リソース
- リソース URL
-
1/wave/dataflows/<dataflowId> - 形式
- JSON
- 使用可能なバージョン
- 37.0
- HTTP のメソッド
- GET PATCH (50.0) PUT
- データフローの実行
- データフローをスケジュールするには、Dataflow Jobs リソース API を使用します。データフローを開始および停止する方法の例については、「データフロージョブまたはレシピの開始と停止」を参照してください。
- データフローのスケジュール
- データフローをスケジュールするには、Schedule Resource API を使用します。データフローをスケジュールする方法の例については、「データフロー、レシピ、データ同期のスケジュール」を参照してください。
- GET の要求パラメータ
-
パラメータ名 型 説明 必須か省略可能 使用可能なバージョン historyId String 履歴 ID を使用して、特定のデータフローバージョンを要求します。 省略可能 42.0 - GET レスポンスボディ (DataflowRepresentation)
-
DataflowRepresentation は、抽象 BaseWaveAssetRepresentation からプロパティを継承します。これらの基本プロパティは、次のテーブルにある DataflowRepresentation の特定のプロパティとともに表示されます。
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン definition Object データフローノードの表現。 Small、50.0 50.0 emailNotificationLevel ConnectEmailNotificationLevelEnum 設定できるメール通知レベルの有効な種別。有効な値は、次のとおりです。 - Always
- Failures
- Never
- Warnings
Small、42.0 42.0 historiesUrl String このデータフローに関連付けられているデータフロー履歴を取得する URL。 Small、46.0 46.0 nextScheduledDate Date 次にスケジュールされた実行の時刻 (ISO8601 日付形式)。 Small、42.0 42.0 scheduleAttributes String データフローのスケジュールの詳細。頻度と開始時刻が含まれています。 Small、42.0 42.0 - PATCH リクエストボディ (DataflowInputRepresentation)
-
DataflowInputRepresentation は、抽象 BaseAssetInputRepresentation からプロパティを継承します。これらの基本プロパティは、次のテーブルにある DataflowInputRepresentation の特定のプロパティとともに表示されます。
パラメータ名 型 説明 必須か省略可能 使用可能なバージョン definition Object データフロー定義。 必須 50.0 historyLabel String ���存済みのデータフローバージョンにタグを付ける履歴の表示ラベル。 省略可能 50.0 - PATCH レスポンスボディ (DataflowRepresentation)
-
DataflowRepresentation は、抽象 BaseWaveAssetRepresentation からプロパティを継承します。これらの基本プロパティは、次のテーブルにある DataflowRepresentation の特定のプロパティとともに表示されます。
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン definition Object データフローノードの表現。 Small、50.0 50.0 emailNotificationLevel ConnectEmailNotificationLevelEnum 設定できるメール通知レベルの有効な種別。有効な値は、次のとおりです。 - Always
- Failures
- Never
- Warnings
Small、42.0 42.0 historiesUrl String このデータフローに関連付けられているデータフロー履歴を取得する URL。 Small、46.0 46.0 nextScheduledDate Date 次にスケジュールされた実行の時刻 (ISO8601 日付形式)。 Small、42.0 42.0 scheduleAttributes String データフローのスケジュールの詳細。���度と開始時刻が含まれています。 Small、42.0 42.0 - PUT リクエストボディ (AssetRevertHistoryInputRepresentation)
- PUT API 要求を使用して、データフローを前の履歴バージョンに戻します。
パラメータ名 型 説明 必須か省略可能 使用可能なバージョン historyId String データフローを戻すデータフローバージョンの履歴 ID。 必須 42.0 historyLabel String 元に戻す変更にタグを付ける履歴の表示ラベル。 省略可能 42.0 次の JSON は、データフローバージョンを元に戻す要求を示しています。1{ 2 "historyId" : "0RmS7000000xxxxxxx" 3} - PUT レスポンスボディ (DataflowRepresentation)
-
DataflowRepresentation は、抽象 BaseWaveAssetRepresentation からプロパティを継承します。これらの基本プロパティは、次のテーブルにある DataflowRepresentation の特定のプロパティとともに表示されます。
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン definition Object データフローノードの表現。 Small、50.0 50.0 emailNotificationLevel ConnectEmailNotificationLevelEnum 設定できるメール通知レベルの有効な種別。有効な値は、次のとおりです。 - Always
- Failures
- Never
- Warnings
Small、42.0 42.0 historiesUrl String このデータフローに関連付けられているデータフロー履歴を取得する URL。 Small、46.0 46.0 nextScheduledDate Date 次にスケジュールされた実行の時刻 (ISO8601 日付形式)。 Small、42.0 42.0 scheduleAttributes String データフローのスケジュールの詳細。頻度と開始時刻が含まれています。 Small、42.0 42.0