Restart Job | RESTful API | Teradata Data Mover - 17.10 - Restart Job (RESTful API) - Teradata Data Mover

Teradata® Data Mover User Guide

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

Purpose

The restart RESTful API restarts a job using the following URL and method:

Item Description
URL /datamover/executingJobs
Method POST

Request Parameters

action
Description: Value "restart" to distinguish from other POST commands on /executingJobs (not case-sensitive)
JSON Data Type: String
Required: Yes
jobExecutionName
Description: Job execution name for restart
JSON Data Type: String
Required: Yes
uowid
Description: Unit of work ID
JSON Data Type: String
Required: No
sync
Description: Specifies if the command is sync
JSON Data Type: Boolean
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 Examples

In this example, sync is false.
 {
     "jobExecutionName" : "executedJob-20141204175020" ,
 "status":"started"
     "links" : [{
             "rel" :  "status"
             "href" :  "http://server/datamover/jobs/executedJob-20141204175020"
         },
 {
             "rel" :  "stop"
             "href" :  "http://server/datamover/jobs/executedJob-20141204175020"
         }
 
     ]
}
In this example, sync is true.
 {
     "jobExecutionName" : "executedJob-20141204175020" ,
     "status" : "FAILED" ,
     "links" : [{
             "rel" :  "status"
             "href" :  "http://server/datamover/jobs/executedJob-20141204175020"
         }
     ]
}
In this example, the job restart failed.
 {
     "error" : "The job failed to execute because another job has already started"
}

restart RESTful API Example

{
    "action":"restart",
    "jobExecutionName":"job_restart-date-time",
    "sync":"true"
}