Start Job | RESTful API | Teradata Data Mover - 17.11 - Start Job (RESTful API) - Teradata Data Mover

Teradata® Data Mover User Guide

Product
Teradata Data Mover
Release Number
17.11
Release Date
October 2021
Content Type
User Guide
Publication ID
B035-4101-091K
Language
English (United States)

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
JSON Data Type: String
Required: Yes
sync
Description: Sync 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.
JSON Data Type: String
Required: Boolean
Required: No
uowid
Description: Unit of work ID
JSON Data Type: String
Required: No
saveChanges
Description: Update original job definition with specified parameters
JSON Data Type: Boolean
Required: No
sourceLogin
Description: Source system properties
JSON Data Type: Object (LoginType)
Required: No
targetLogin
Description: Target system properties
JSON Data Type: Object (LoginType)
Required: No
settings
Description: Job configuration properties
JSON Data Type: Object (SettingsType)
Required: No
jobSecurity
Description: Job security details
JSON Data Type: Object (JobSecurityType)
Required: No
objects
Description: Objects to be copied
JSON Data Type: Object (DbObjectType)
Required: No

Response Parameters

jobExecutionName
Description: Job execution name if job executed, or blank if not executed
JSON Data Type: String
status
Description: Status of job
JSON Data Type: String

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"
        }
     },
 
}