Analytics REST API 開発者ガイド
jDataflow Jobs List リソース
- リソース URL
-
1/wave/dataflowjobs - 形式
- JSON
- 使用可能なバージョン
- 42.0
- 使用可能なコンポーネント
- HTTP のメソッド
- GET POST
- GET の要求パラメータ
-
パラメータ名 型 説明 必須か省略可能 使用可能なバージョン dataflowId ID この特定のデータフローに関連付けられているデータフロージョブのみを含むようにコレクションを絞り込みます。ID の先頭が「02K」である必要があります。 /wave/dataflowjobs?dataflowId=02K0000000xxxxx
省略可能 42.0 jobTypes ConnectJobTypeEnum[] 特定のジョブ種別のデータフロージョブのみを含むようにコレクションを絞り込みます。有効な値は、次のとおりです。 - DataSync
- FileUpload
- Internal
- Orchestrated
- Recipe
- Recipe_V3
- Report
- Restore
- User
/wave/dataflowJobs?jobTypes=Recipe,DataSync
省略可能 53.0 licenseType ConnectAnalyticsLicenseTypeEnum コレクションを Analytics ライセンスの種類で絞り込みます。有効な値は、次のとおりです。 - EinsteinAnalytics (Analytics)
- MulesoftDataPath (Mulesoft Data Works)
- Sonic (Salesforce データパイプライン)
省略可能 53.0 page String 生成されたトークン。返されるデータフロージョブのビューを示します。 省略可能 51.0 pageSize Integer 1 ページで返される項目の数。最小値は 1、最大値は 200、デフォルトは 25 です。 省略可能 51.0 q String 検索語。各用語はスペースで区切られます。ワイルドカードは、クエリ文字列の最後のトークンに自動的に付加されます。ユーザの検索クエリに疑問符またはワイルドカードが含まれている場合、それらの記号は URI で他の特殊文字と同様にクエリ文字列から自動的に削除されます。 省略可能 51.0 startedAfter String 指定された日時 (UTC のエポック秒) 以降に開始されたデータフロージョブのみを含むようにコレクションを絞り込みます。 /wave/dataflowJobs?startedBefore=1622582667
省略可能 53.0 startedAfter String 指定された日時 (UTC のエポック秒) 以降に開始されたデータフロージョブのみを含むようにコレクションを絞り込みます。 /wave/dataflowJobs?startedAfter=1622582667
省略可能 53.0 status ConnectWaveDataflowJobStatusEnum 特定のランタイム状況のデータフロージョブのみを含むようにコレクションを絞り込みます。有効な値は、次のとおりです。 - Failure
- Queued
- Running
- Success
- Warning
省略可能 51.0 - GET のレスポンスボディ
- Dataflow Job Collection
- POST のリクエストボディ
- POST API 要求を使用して、データフローを開始します。データフローを停止するには、/wave/dataflowjobs/<dataflowjobId> で PATCH 要求を使用します。Dataflow Job Input
次の JSON は、dataflowJob を開始する方法を示しています。
1{ 2 "dataflowId": "02KS700000004G3eMAE", 3 "command" : "start" 4} - POST のレスポンスボディ
- Dataflow Job
- データフロージョブの開始または停止
- データフロージョブを開始および停止する方法の例については、「データフロージョブまたはレシピの開始と停止」を参照してください。