概要
start RESTful APIは、次のURLとメソッドを使用して指定したジョブを開始します。
アイテム | 説明 | ||
---|---|---|---|
URL | /datamover/executingJobs | ||
メソッド | POST |
objectsフィールドのパラメータがジョブ仕様の要件を満たすときには、ジョブが存在しない場合でもstartコマンドはジョブを作成します。その場合、saveChangesパラメータは無視され、新しいジョブが保存されます。
リクエストのパラメータ
- jobName
- 説明: ジョブ名
- sync
- 説明: Sync使用の仕様 syncがfalse(デフォルト)の場合、startコマンドはジョブ実行名が生成されたときのステータスを返します。 syncがtrueの場合、startコマンドはジョブが完了するとステータスを返します。
- uowid
- 説明: 作業単位ID
- saveChanges
- 説明: 指定されたパラメータで元のジョブ定義を更新します
- sourceLogin
- 説明: ソース システムのプロパティ
- targetLogin
- 説明: ターゲット システムのプロパティ
- settings
- 説明: ジョブ構成プロパティ
- jobSecurity
- 説明: ジョブのセキュリティの詳細
- objects
- 説明: コピーするオブジェクト
応答のパラメータ
- jobExecutionName
- 説明: ジョブが実行された場合はジョブ実行名、実行されなかった場合は空白
- status
- 説明: ジョブのステータス
応答の例
この例では、ジョブが存在せず、新しいジョブの仕様が十分でないために、ジョブの開始が失敗しました。
{ "message" : "Job not found and could not create a new job: Error: Cannot get database version info for system dmsmp2" }
start RESTful APIの例
{ "jobName" : "executedJob" , "sync" : "true", "saveChanges" : "true", "sourceLogin": { "teradata": { "tdpid":"dmdev" "username": "dbc", "password": "dbc" } }, }