Overview
The start RESTful API starts the specified job using the following URL and method:
Item | Description | ||
---|---|---|---|
URL | /datamover/executingJobs | ||
Method | POST |
The start command creates a job, even if the job does not already exist, when parameters in the objects field meet job specification requirements. When this occurs, the saveChanges parameters are ignored and a new job is saved.
Request Parameters
- jobName
- Description: Job name
- sync
- Description: Synx use specification If sync is false (default), the start command returns status when the job execution name is generated. If sync is true, the start command returns status when the job is complete.
- uowid
- Description: Unit of work ID
- saveChanges
- Description: Update original job definition with specified parameters
- sourceLogin
- Description: Source system properties
- targetLogin
- Description: Target system properties
- settings
- Description: Job configuration properties
- objects
- Description: Objects to be copied
Response Parameters
- jobExecutionName
- Description: Job execution name if job executed, or blank if not executed
- status
- Description: Status of job
Status Codes
If the command executes without error, the API returns status code 200 in the response header and nothing in the response body.
If an error occurs during execution, the API returns a non-200 status code in the response header and an error message in JSON format in the response body.
Response Example
In this example, job start failed due to non-existent job and insufficient new job specifications.
{ "message" : "Job not found and could not create a new job: Error: Cannot get database version info for system dmsmp2" }
start RESTful API Example
{ "jobName" : "executedJob" , "sync" : "true", "saveChanges" : "true", "sourceLogin": { "teradata": { "tdpid":"dmdev" "username": "dbc", "password": "dbc" } }, }