Job Status | RESTful API | Teradata Data Mover - 17.10 - Status Job (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)

Overview

The status RESTful API displays the status of an executed job using the following URL and method:

Item Description
URL /datamover/executedJobs/executed-job-name

/datamover/executingJobs/executed-job-name

Method GET

Request Parameters

outputLevel
URL: /datamover/executingJobs/executed-job-name?outputLevel=value
URL: /datamover/executedJobs/executed-job-name?outputLevel=value
Description: Specifies output level of the job status. The output level options are defined in the following table:
Output Level Description
1 Overall job status (default)
2 Status of each job step
3 Status of each job task
4 Detailed log information

You must use outputLevel=4 when the job status is NEW to get detailed job information.

If the outputLevel parameter is not specified, then it defaults to output_level 1.
Required: No

Response Parameters

currentStep
Description: Most current step ID for the job, null if never executed
JSON Data Type: Integer
Output Level: 2
endTime
Description: End time of job, null if never executed
JSON Data Type: String
Output Level: 1
estimatedJobSize
Description: High estimate of job size
JSON Data Type: Long
Output Level: 1
jobExecutionId
Description: Job execution identification
JSON Data Type: Long
Output Level: 1
jobName
Description: Job name (maximum characters: 237)
JSON Data Type: String
Output Level: 1
jobExecutionName
Description: Job execution name
JSON Data Type: String
Output Level: 1
lifeCycle
Description: Lists all the events during job creation and execution
JSON Array: Object (LifeCycleStatus)
Output Level: 3
log
Description: Displays the utility log output
JSON Data Type: String
Output Level: 4
rowCount
Description: Row count results of the source and target objects if row count validation steps exist
JSON Array: Object (RowCountStatus)
Output Level: 3
startTime
Description: Start time of job, null if never executed
JSON Data Type: String
Output Level: 1
status
Description: Status of the job (maximum characters: 12), where possible values are listed in the status description for Request Parameters
JSON Data Type: String
Output Level: 1
steps
Description: Lists all the last steps of the job, null if never executed
JSON Array: Object (StepType)
Output Level: 2
streams
Description: Lists streams, if available
JSON Array: Object (StreamInfo)
Output Level: 3
submitTime
Description: Time when job was submitted
JSON Data Type: String
Output Level: 1
tasks
Description: Lists all the individual tasks for each object, null if never executed
JSON Array: Object (TaskStatus)
Output Level: 3

Response Example

The following example shows an array of job executions with the most common status. The links generated depend on job status.
{
  "jobName" : "job1-20200128112954",
  "jobExecutionName" : "job1-20200128112954",
  "jobExecutionId" : 25,
  "currentStep" : 3,
  "startTime" : 1580239796717,
  "endTime" : 1580239811907,
  "status" : "COMPLETED",
  "steps" : [ {
    "id" : 1,
    "status" : "COMPLETED",
    "type" : "VERIFY_JOB_OBJECTS",
    "startTime" : 1580239799361,
    "endTime" : 1580239800076
  }, {
    "id" : 2,
    "status" : "COMPLETED",
    "type" : "COMPARE_DDL",
    "startTime" : 1580239800186,
    "endTime" : 1580239802157
  }, {
    "id" : 3,
    "status" : "COMPLETED",
    "type" : "MOVE_TABLE_DATA",
    "startTime" : 1580239802203,
    "endTime" : 1580239811792
  } ],
  "tasks" : [ {
    "id" : 2570,
    "movePhase" : "VALIDATING",
    "status" : "COMPLETE",
    "timestamp" : 1580239799774
  }, {
    "id" : 2571,
    "movePhase" : "COMPARE_DDL",
    "status" : "COMPLETE",
    "agentName" : "Agent1",
    "utility" : "SQL",
    "timestamp" : 1580239801883
  }, {
    "id" : 2572,
    "movePhase" : "MOVING_DATA",
    "status" : "COMPLETE",
    "objectType" : "table",
    "agentName" : "Agent1",
    "utility" : "DSA",
    "timestamp" : 1580239804392
  } ],
  "links" : [ {
    "rel" : "self",
    "href" : "https://localhost:1443/datamover/executedJobs/job1-20200128112954?outputLevel=3"
  } ]