List Job Definition | RESTful API | Teradata Data Mover - List Job Definition (RESTful API) - Teradata Data Mover

Teradata® Data Mover User Guide

Product
Teradata Data Mover
Release Number
17.00
Published
November 30, 2021
Language
English (United States)
Last Update
2021-11-04
dita:mapPath
gmn1574692806523.ditamap
dita:ditavalPath
cjo1509024828169.ditaval
dita:id
B035-4101
lifecycle
previous
Product Category
Analytical Ecosystem

Purpose

Display the definition of a job using the following URL and method:
Item Description
URL /datamover/jobs/job-name
Method GET

Request Parameters

No required request parameters.

Response Parameters

jobName
Description: Job name
JSON Data Type: String
uowid
Description: Unit of work id
JSON Data Type: String
sourceLogin
Description: Source system properties
JSON Data Type: Object (LoginType)
targetLogin
Description: Target system properties
JSON Data Type: Object (LoginType)
settings
Description: Job configuration properties
JSON Data Type: Object (SettingsType)
objects
Description: Objects to be copied
JSON Data Type: Object (DbObjectType)
jobSecurity details are not displayed in list job definition even though jobSecurity details are provided when creating or editing a job.

Response Example (Teradata to Teradata UserPool)

{
    "jobName": "tdToTdJob",
    "sourceLogin":
    {
        "teradata":
        {
            "tdpid": "sourceSystem",
            "username": "user",
            "password": "",
            "sessionCharset": "UTF8",
            "passwordEncrypted": "false"
        }
    },
    "targetLogin":
    {
        "userPool": "poolA"
    },
    "settings":
    {
        "priority": "MEDIUM",
        "overwriteExistingObjects": "true",
        "freezeJobSteps": "false",
        "targetDatabase": "targetDatabaseJobLevel",
        "compareDDL": "true",
        "logLevel": "99",
        "tdTdSettings":
        {
            "forceUtility": "DSA",
            "dataStreams": 5,
            "sourceSessions": 10,
            "targetSessions": 10,
            "onlineArchive": "false"
        }
    },
    "objects":
        {
            "database":
            [
                {
                    "name": "sourceDb",
                    "compareDDL": "false",
                    "journaling": "false",
                    "replaceDatabase": "false",
                    "selection": "unselected",
                    "table":
                    [
                        {
                            "name": "srcTableA",
                            "stagingDatabase": "stagingDBA",
                            "stagingDatabaseForTable": "stagingDBAB",
                            "targetDatabase": "targetDBA",
                            "targetName": "tgtTableA",
                            "validateRowCount": "ALL",
                            "compareDDL": "false",
                            "forceTargetStagingTable": "true",
                            "selection": "included",
                            "exportWithoutSpool": "false"
                        },
                        {
                            "name": "srcTableB",
                            "compareDDL": "true",
                            "selection": "included",
                            "exportWithoutSpool": "true",
                            "partialTableParameters":
                            {
                                "sqlWhereClause": "where columnA < 100",
                                "keyColumns":
                                [
                                    "columnA"
                                ]
                            },
                            "teradataParameters":
                            {
                                "copyStats": "false",
                                "allowTPTLoadMultiset": "true",
                                "journaling": "false",
                                "overrideLockAccess": "false"
                            }
                        }
                    ]
                }
            ],
            "trigger":
            [
                {
                    "database": "databaseA",
                    "subjectTableDatabase": "subjectDatabaseA",
                    "table": "tableA",
                    "name": "triggerA",
                    "actionTime":
                    {
                        "action": "AFTER",
                        "enabled": "NO"
                    },
                    "selection": "included"
                },
                {
                    "database": "databaseB",
                    "subjectTableDatabase": "subjectDatabaseB",
                    "table": "tableB",
                    "name": "triggerB",
                    "actionTime":
                    {
                        "action": "AFTER",
                        "enabled": "YES"
                    },
                    "selection": "included"
                }
            ],
            "view":
            [
                {
                    "name": "ViewA",
                    "database": "ViewDatabase",
                    "viewDataTable":
                    {
                        "targetTable": "tableA",
                        "targetDatabase": "dbA"
                    },
                    "compareDDL": "false",
                    "selection": "included",
                    "copyData": "false"
                },
                {
                    "name": "ViewB",
                    "database": "ViewDatabaseB",
                    "viewDataTable":
                    {
                        "targetTable": "tableA",
                        "targetDatabase": "dbA"
                    },
                    "compareDDL": "false",
                    "forceTargetStagingTable": "true",
                    "selection": "included",
                    "copyData": "false"
                }
            ],
            "foreignServer":
            [
                {
                    "name": "foreignServer1",
                    "selection": "included"
                },
                {
                    "name": "foreignServer2",
                    "selection": "included"
                }
            ],
            "functionAliases":
            [
                {    
                   "name": "faObj",
                   "database": "dmguest",
                   "selection": "included"
                },
                {
                   "name": "FAObjForForeignSer",
                   "database": "myDB",
                   "selection": "included"
                }
            ]
            "journal":
            [
                {
                    "name": "journal",
                    "database": "journalDB",
                    "selection": "included"
                }
            ],
            "macro":
            [
                {
                    "name": "macroA",
                    "database": "macroDB",
                    "selection": "included"
                },
                {
                    "name": "macroB",
                    "database": "macroDB",
                    "selection": "included"
                }
            ],
            "indices":
            [
                {
                    "name": "OrdersHI",
                    "indexDatabase": "indexDB",
                    "indexType": "hash_index",
                    "selection": "included"
                },
                {
                    "name": "sji",
                    "indexDatabase": "indexDB",
                    "indexType": "join_index",as
                    "copyStats": true,
                    "selection": "included"
                }
            ],
            "schema":
            [
                {
                    "name": "avroRecordSchema",
                    "compareDDL": true,
                    "selection": "included"
                }
            ],
            "storedProcedure":
            [
                {
                    "name": "storedProcedureA",
                    "database": "storedProcedureDB",
                    "selection": "included"
                },
                {
                    "name": "storedProcedureB",
                    "database": "storedProcedureDB",
                    "selection": "included"
                }
            ]
        }

Response Example (Teradata to Hadoop)

{  
   "jobName":"tdToHadoopJob",
   "sourceLogin":{  
      "userPool": "poolA"
   },
   "targetLogin":{  
      "hadoop":{  
         "webhcatURL":"http://zircon1.labs.teradata.com:50111",
         "fileSystemURL":"http://zircon1.labs.teradata.com:50070",
         "oozieURL":"http://zircon1.labs.teradata.com:11000",
         "username":"hive",
         "passwordEncrypted":"false"
      }
   },
   "setting":{  
      "priority":"MEDIUM",
      "overwriteExistingObjects":"true",
      "freezeJobSteps":"false",
      "compareDDL":"true",
      "tdHadoopSettings":{  
         "forceUtility":"SQLH",
		 "foreignServer" : "ForeginServerForSQLH",
         "fileOptions":"text",
         "columnDelimiter":"|",
         "batchInsertSize":0,
         "mappers":10
      }
   },
   "objects":{  
      "database":[  
         {  
            "name":"sourceDb",
            "compareDDL":"false",
            "journaling":"false",
            "replaceDatabase":"false",
            "selection":"unselected",
            "table":[  
               {  
                  "name":"srcTableA",
                  "targetName":"tgtHadoopTableA",
                  "compareDDL":"false",
                  "selection":"included",
                  "exportWithoutSpool":"false",
                  "column":[  
                     {  
                        "name":"lastName",
                        "targetName":"surname",
                        "targetType":"String",
                        "allowNull":"false",
                        "allowDuplicate":"false",
                        "primaryIndex":"false"
                     },
                     {  
                        "name":"Street number",
                        "targetType":"int",
                        "allowNull":"false",
                        "allowDuplicate":"false",
                        "primaryIndex":"false"
                     }
                  ],
				  "partialTableParameters":{  
                     "sqlWhereClause":"WHERE id > 4"
                  }
               }
            ]
         }
      ],
      "view":[  
         {  
            "name":"sourceViewA",
            "database":"sourceDB",
            "viewDataTable":{  
               "targetTable":"targetTableToStoreViewData",
               "targetDatabase":"targetDB"
            },
            "validateRowCount":"PARTIAL",
            "useSourceStagingTable":false,
            "forceTargetStagingTable":false,
            "partialTable":{  
               "sqlWhereClause":"WHERE id>1"
            },
            "selection":"unselected",
            "copyData":true
         }
      ]
   }
 }