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

Teradata® Data Mover User Guide

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

Purpose

Display the list of steps for a specified job without starting or running the job using the following URL and method:
Item Description
URL /datamover/jobs/job-name/steps
Method GET

Request Parameters

No required request parameters.

Response Parameters

jobName
Description: Name of the job
JSON Data Type: String
sourceLogin
Description: Properties to specify source system
JSON Data Type: Object (LoginType)
targetLogin
Description: Properties to specify target system
JSON Data Type: Object (LoginType)
steps
Description: Steps of the job
JSON Data Type: JSON Array (RestStepListType)
sourceSessions
Description: Source session used
JSON Data Type: SessionsAndStreamsType
targetSessions
Description: Target session used
JSON Data Type: SessionsAndStreamsType
dataStreams
Description: Data Stream used
JSON Data Type: SessionsAndStreamsType

Example

{
    "jobName": "tdToTdJob",
    "sourceLogin":    
    {
        "teradata":
        {
            "tdpid": "sourceSystem",
            "username": "user",
            "password": "password",
            "sessionCharset": "UTF8",
            "passwordEncrypted": "false"
        }
    },
    "targetLogin":
    {
        "userPool": "poolA"
    },
    "steps":
    [
        {
            "id": "422",
            "type": "VERIFY_JOB_OBJECTS"
        },
        {
            "id": "423",
            "type": "COMPARE_DDL"
        },
        {
            "id": "424",
            "type": "MOVE_TABLE_DATA"
            "tasks":
            [  
                {
                    "type": "ARCTaskType",
                    "id": "494",
                    "arc_tasks":
                    [
                        {
                            "name": "archive_script",
                            "value": "ARCHIVE DATA TABLES
                                        ("test"."test"),
                                        SKIP JOIN INDEX,
                                        skip stat collection,
                                        RELEASE LOCK,
                                        FILE=ARCHIVE;
                                        LOGOFF;"
                        },
                        {
                            "name": "copy_script",
                            "value": "LOGON $LOGON;
                                        COPY DATA TABLES
                                        ("test"."test"),
                                        skip stat collection,
                                        RELEASE LOCK,
                                        FILE=ARCHIVE;
                                        LOGOFF;"
                        }
                    ]
                }          
            ]          
        }
    ],
    "sourceSessions":{
        "value": 2,
        "type": "SYSTEM_GENERATED"
    },
    "targetSessions":{
        "value": 2,
        "type": "SYSTEM_GENERATED"
    },
    "dataStreams":{
        "value": 1,
        "type": "SYSTEM_GENERATED"
    }
}