create 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 create RESTful API creates a job using the following URL and method:
Item Description
URL /datamover/jobs
Method POST

Request Parameters

jobName
Description: Name of the job
JSON Data Type: String
Required: No
uowid
Description: Unit of work id
JSON Data Type: String
Required: No
sourceLogin
Description: Properties of the source system
JSON Data Type: Object (LoginType)
Required:Yes
targetLogin
Description: Properties of the target system
JSON Data Type: Object (LoginType)
Required:Yes
settings
Description: Properties of the job configuration
JSON Data Type: Object (SettingsType)
Required: No
objects
Description: Objects to be copied
JSON Data Type: Array (DbObjectType)
Required: Yes

Response Parameters

The create RESTful API does not include specific response parameters.

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

{
    "error":"job creation failed, table does not exist in source database"
}