Create a Cloud Staging Copy Job | RESTful API | Teradata Data Mover - Create a Cloud Staging Copy Job (RESTful API) - Teradata Data Mover

Teradata® Data Mover User Guide - 20.01

Deployment
VantageCloud
VantageCore
Edition
Enterprise
IntelliFlex
Lake
VMware
Product
Teradata Data Mover
Release Number
20.01
Published
November 2023
Language
English (United States)
Last Update
2023-12-05
dita:mapPath
hlv1700545853003.ditamap
dita:ditavalPath
mpm1591127278842.ditaval
dita:id
don1467241476387
Product Category
Analytical Ecosystem

Overview

You need a valid cloud staging area for creating a cloud staging copy Job. To create a cloud staging copy Job add a cloudStagingArea object inside the settings object of the request JSON. Make sure that the object specifies a valid cloud staging area for the job.

Create a cloud staging copy 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
uowind
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
jobSecurity
Description: Job security details
JSON Data Type: Object (JobSecurityType)
Required: No
objects
Description: Objects to be copied
JSON Data Type: Object (DBObjectType)
Required: Yes

Response Parameters

No response parameters required.

Response Example

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

Request Example

{
    "jobName": "DMCSJob",
    "sourceLogin": {
        "teradata": {
            "username": "user",
            "password": "password",
            "tdpid": "sourceSystem",
            "sessionCharset": "UTF8",
            "passwordEncrypted": "false"
        }
    },
    "targetLogin": {
        "teradata": {
            "username": "user",
            "password": "password",
            "tdpid": "targetSystem"
        },
        "useTargetUserIdPool": false
    },
    "settings": {
        "priority": "MEDIUM",
        "overwriteExistingObjects": "true",
        "freezeJobSteps": "false",
        "targetDatabase": "targetDatabaseJobLevel",
        "compareDDL": "true",
        "logLevel": "99",
        "tdTdSettings":
        {
            "forceUtility": "DSA",
            "dataStreams": 5,
            "sourceSessions": 10,
            "targetSessions": 10,
            "onlineArchive": "false"
        },
        "enableTraceLog": {
            "cliTraceLog": {
                "netrace": -1,
                "netraceBufLen": -1
            },
            "tptTraceLog": {
                "tptapiDebug": -1
            }
        },
        "cloudStagingArea": {
            "name": "CSArea"
        },
        "enableIncrementalRestore": "FALSE"
    },
    "objects": {
        "database": [{
            "name": "dm19948",
            "selection": "UNSELECTED",
            "table": [{
                "name": "testtable",
                "ownerName": "devuser",
                "useSourceStagingTable": false,
                "forceTargetStagingTable": false,
                "targetDatabase": "test",
                "targetName": "test",
                "validateRowCount": "NONE",
                "selection": "INCLUDED",
                "teradataParameters": {
                    "allowTPTLoadMultiset": false,
                    "overrideLockAccess": false
                }
            }]
        }]
    }
}