RESTful API Calls Overview | Teradata Data Mover - 17.11 - Data Mover RESTful API Calls - 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)
Calls to the Data Mover RESTful API service involve the following elements:
  • HTTPS is enabled by default.
  • All calls to the Data Mover RESTful interface return an HTTPS 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 return information in the body of the response in JSON format.
  • A URL identifying the Data Mover server on which the REST service is running such as, https://dmprod:1443/datamover/jobs.dmprod where each part of the path defines the following:
    • dmprod – the DNS alias of the Data Mover server
    • 1443 – the default port on which the REST service is listening
    • /datamover/jobs – the REST resource being referenced
  • Each call to the Data Mover RESTful API is made using a specific HTTPS method: GET, POST, PUT, or DELETE. Using different HTTPS methods on the same REST resource performs different actions, such as the following examples:
    • Using GET on /datamover/jobs returns a list of all Data Mover jobs
    • Using POST on /datamover/jobs creates a new job

    All 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.

  • Some calls to a Data Mover RESTful API require an input parameter. Input parameters are either specified in the body of the request in JSON format or provided in the URL path itself.

    An example of the URL path is, https://dmprod:1443/datamover/jobs/job-name?outputLevel=4 where outputLevel=4 is a parameter.