Data Mover 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

Data Mover RESTful APIs provide interface to Data Mover functions through standard HTTP requests. You can access the Data Mover RESTful service using any standard REST client. For example, you can use REST client modules provided in scripting languages like Python or PERL, or those provided in visual tools like Firefox RESTClient Add-on.

Calls to the Data Mover RESTful service involve the following elements:
  • URL identifying the Data Mover server on which the REST service is running, the port on which the REST service is listening (1080 by default), and the REST resource being referenced. For example: http://dmprod:1080/datamover/jobs.dmprod is the DNS alias of the Data Mover server, 1080 is the default REST port, and /datamover/jobs is the REST resource.
  • Each call to the Data Mover RESTful API is made using a specific HTTP method: GET, POST, PUT, or DELETE. Using different HTTP methods on the same REST resource performs different actions. For example, using GET on /datamover/jobs returns a list of all Data Mover jobs; whereas, using POST on /datamover/jobs creates a new job. Calls to the Data Mover RESTful interface must include an Accept Header with the version of the API being used. The header provided is a key-value pair. The key is 'Accept' and the current version value is 'application/vnd.com.teradata.datamover-v1.0+json'.
  • Calls to a Data Mover RESTful API may require an input parameter. Some input parameters are provided in the URL path itself. For example: http://dmprod:1080/datamover/jobs?outputLevel=4 where "outputLevel=4" is a parameter. Other input parameters are specified in the body of the request in JSON format.
  • All calls to the Data Mover RESTful interface return an HTTP status code that indicates whether the call was successful or not. For more information, see RESTFul API Status Codes.
  • Some calls to the Data Mover RESTful Interface will return information in the body of the response in JSON format.