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

Teradata® Data Mover User Guide

Product
Teradata Data Mover
Release Number
17.10
Release Date
June 2021
Content Type
User Guide
Publication ID
B035-4101-061K
Language
English (United States)

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" : "job1",
  "sourceLogin" : {
    "teradata" : {
      "tdpid" : "source1",
      "username" : "sourceuser",
      "passwordEncrypted" : false
    }
  },
  "targetLogin" : {
    "teradata" : {
      "tdpid" : "starget1",
      "username" : "targetuser",
      "passwordEncrypted" : false
    }
  },
  "steps" : [ {
    "type" : "VERIFY_JOB_OBJECTS",
    "id" : 2564
  }, {
    "type" : "COMPARE_DDL",
    "id" : 2568
  }, {
    "tasks" : [ {
      "type" : "DSATaskType",
      "dsaJobName" : "849_table",
      "jobModelJson" : "{\n  \"jobName\" : \"849_table\",\n  \"jobDescription\" : \"DSA job for data mover job: job1\",\n  \"jobType\" : \"DATA_MOVEMENT\",\n  \"dataDictionaryType\" : \"DATA\",\n  \"objectList\" : [ {\n    \"objectName\" : \"table1\",\n    \"objectType\" : \"TABLE\",\n    \"parentType\" : \"DATABASE\",\n    \"parentName\" : \"parent\"\n  } ],\n  \"jobSettings\" : {\n    \"skipStats\" : true,\n    \"online\" : false,\n    \"loggingLevel\" : \"Debug\",\n    \"blockLevelCompression\" : \"DEFAULT\",\n    \"runAsCopy\" : true,\n    \"queryband\" : \"SET QUERY_BAND='ApplicationName=DM;Version=16.20.50.01;'\",\n    \"numberParallelBuilds\" : 5,\n    \"nosync\" : false,\n    \"temperatureOverride\" : \"DEFAULT\",\n    \"disableFallback\" : false,\n    \"nowait\" : true,\n    \"streamsSoftlimit\" : 2,\n    \"skipJoinhashIndex\" : true\n  }\n}",
      "id" : 2569
    } ],
    "type" : "MOVE_TABLE_DATA",
    "id" : 2569
  } ],
  "sourceSessions" : {
    "value" : 2,
    "type" : "SYSTEM_GENERATED"
  },
  "targetSessions" : {
    "value" : 2,
    "type" : "SYSTEM_GENERATED"
  },
  "dataStreams" : {
    "value" : 2,
    "type" : "SYSTEM_GENERATED"
  }
}