restart RESTful API - Teradata Data Mover

Teradata Data Mover User Guide

Product
Teradata Data Mover
Release Number
16.00
Published
December 2016
Language
English (United States)
Last Update
2018-03-29
dita:mapPath
rdo1467305237457.ditamap
dita:ditavalPath
ft:empty
dita:id
B035-4101
lifecycle
previous
Product Category
Analytical Ecosystem

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

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