List Jobs | RESTful API | Teradata Data Mover - 17.11 - List Jobs (RESTful API) - Teradata Data Mover

Teradata® Data Mover User Guide

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

Purpose

Data Mover provides the following filter variations when listing jobs:
  • Jobs that meet the specified conditions, including start time, end time, and status
  • Jobs that ran and met the specified conditions, including start time, end time, status, and priority
  • Jobs currently running that meet the specified conditions, including start time, status, and priority
  • Jobs that have frozen steps
Item Description
URL

/datamover/jobs

/datamover/executedJobs

/datamover/executingJobs

/datamover/jobs?freezeJobStepsOnly=value

Method GET

Request Parameters (/datamover/jobs)

This variation returns a list of job names that meet the specified conditions, including start time, end time, and status. If no parameters are supplied, a list of new and completed jobs is returned.

startTimeAfter
Description: Jobs started later than specified time
Restriction: Cannot be used with endTimeAfter
URL: /datamover/jobs?startTimeAfter=value
JSON Data Type: String (with ISO 8601 UTC date format), for example: 2015-07-01T17:38:12Z
Required: No
endTimeBefore
Description: Jobs finished earlier than specified time.
Restriction: Cannot be used with endTimeAfter
URL: /datamover/jobs?endTimeBefore=value
JSON Data Type: String (with ISO 8601 UTC date format), for example: 2015-07-01T17:38:12Z
Required: No
endTimeAfter
Description: Jobs finished later than specified time.
Restriction: Cannot be used with endTimeBefore or startTimeAfter.
URL: /datamover/jobs?endTimeAfter=value
JSON Data Type: String (with ISO 8601 UTC date format), for example: 2015-07-01T17:38:12Z
Required: No
freezeJobStepsOnly
Description: List only jobs that have freezeJobStepsOnly set to true
URL: /datamover/jobs?freezeJobStepsOnly=value
Accepted values: True or False
  • true = list jobs that have freeze job steps
  • false = return all jobs, regardless of freeze steps
JSON Data Type: Boolean
Required: No
jobName
Description: Job name
JSON Data Type: String
Required: No
latestJobsOnly
Description: List the most recent job that ran in the daemon.
URL: /datamover/jobs?latestJobsOnly=value
Accepted values: True or False
  • true = list only the most recently executed job
  • false = list all jobs
JSON Data Type: Boolean
Required: No
status
Description: Jobs with last starting status that matches one of the following:
  • NEW: All new jobs
  • INITIALIZING: All initializing jobs
  • RUNNING: All running jobs
  • BLOCKED: All blocked jobs
  • COMPLETED: All successfully completed jobs
  • FAILED: All failed jobs
  • RESTARTING: All restarting jobs
  • CANCELLED: All user-cancelled jobs
  • QUEUED: All queued jobs
URL: /datamover/jobs?status=value
JSON Data Type: String
Required: No

Response Parameters (/datamover/jobs)

jobExecutionName
Description: Started job name
JSON Data Type: String
jobName
Description: Job name (maximum characters: 237)
JSON Data Type: String
startTime
Description: Start time if job has started or null if job did not start
JSON Data Type: String (with ISO 8601 UTC date format), for example: 2015-07-01T17:38:12Z
endTime
Description: End time if job has started or null if job did not start
JSON Data Type: String (with ISO 8601 UTC date format), for example: 2015-07-01T17:38:12Z
status
Description: Status of the job (maximum characters: 12), where possible values are specified in the Request Parameters section
JSON Data Type: String
Priority
Description: Priority of the job if started (maximum characters: 11), where the value is one of the following:
  • UNSPECIFIED
  • LOW
  • MEDIUM
  • HIGH
JSON Data Type: String

Response Example (/datamover/jobs)

This example shows an array of jobs with a start time later than the specified time, no jobs are found, and an empty array.
[
     {
         "jobName" :  "runningJob" ,
         "startTime" : "2015-07-16T17:14:13Z",
         "endTime" :  null ,
         "status" :  "RUNNING" ,
         "priority" :  "MEDIUM" ,
         "links" : 
          [
             {
                 "rel" :  "status" ,
                 "href" :  "http://server/datamover/executingJobs/runningJob-1417744247669"
                              
             },
             {
                 "rel" :  "past_executions" ,
                 "href" :  "http://server/datamover/executedJobs?jobName=runningJob&startTimeAfter=<value>"
                              
             }
            {
                 "rel" :  "job_steps" ,
                 "href" :  "http://server/datamover/jobs/runningJob/steps"
                              
             }
         ]
     },
     {
         "jobName" :  "successfulJob" ,
         "startTime" : "2015-07-16T17:14:13Z",
         "endTime" : "2015-07-16T19:14:13Z",
         "status" :  "COMPLETED" ,
         "priority" :  "MEDIUM" ,
         "links" : 
         [
             {
                 "rel" :  "status" ,
                 "href" :  "http://server/datamover/executedJobs/successfulJob-20141204175020"
                              
             },
             {
                 "rel" :  "past_executions" ,
                 "href" :  "http://server/datamover/executedJobs?jobName=successfulJob
                                &startTimeAfter=<value>
                                "
                              
             }
            {
                 "rel" :  "job_steps" ,
                 "href" :  "http://server/datamover/jobs/successfulJob/steps"
                              
             }
         ]
     },
     {
         "jobName" :  "failedJob" ,
         "startTime" : 1417744247669,
         "endTime" : 1417744323437,
         "status" :  "FAILED" ,
         "priority" :  "MEDIUM" ,
         "links" : 
         [
             {
                 "rel" :  "status" ,
                 "href" :  "http://server/datamover/executedJobs/failedJob-20141204175020"
                              
             },
             {
                 "rel" :  "past_executions" ,
                 "href" :  "http://server/datamover/executedJobs?jobName=failedJob
                                &startTimeAfter=<value>
                                "
                              
             }
            {
                 "rel" :  "job_steps" ,
                 "href" :  "http://server/datamover/jobs/failedJob/steps"
                              
             }
         ]
     }
]             

Request Parameters (/datamover/executedJobs)

This variation returns a list of job names that meet the specified conditions, including jobs that are new or are running.

startTimeAfter
Description: Jobs started later than specified time
Restriction: Cannot be used with endTimeAfter
URL: /datamover/executedJobs
JSON Data Type: String (with ISO 8601 UTC date format), for example: 2015-07-01T17:38:12Z
Required: No
endTimeBefore
Description: Jobs finished earlier than specified time
Restriction: Cannot be used with endTimeAfter
URL: /datamover/executedJobs?endTimeBefore=value
JSON Data Type: String (with ISO 8601 UTC date format), for example: 2015-07-01T17:38:12Z
Required: No
endTimeAfter
Description: Jobs finished later than specified time
Restriction: Cannot be used with startTimeAfter or endTimeBefore
URL: /datamover/executedJobs?endTimeBefore=value
JSON Data Type: String (with ISO 8601 UTC date format), for example: 2015-07-01T17:38:12Z
Required: No
status
Description: Jobs with last run status that matches one of the following:
  • COMPLETED: All successfully completed jobs
  • FAILED: All failed jobs
  • CANCELLED: All user-cancelled jobs
URL: /datamover/executedJobs?endTimeBefore=value
JSON Data Type: String
Required: No
jobName
Description: Started jobs mapped to the specified name
URL: /datamover/executedJobs?jobName=value
JSON Data Type: String
Required: No

Response Parameters (/datamover/executedJobs)

endTime
Description: End time if job has started or null if not started
JSON Data Type: String (with ISO 8601 UTC date format), for example: 2015-07-01T17:38:12Z
estimatedJobSize
Description: High estimate of job size
JSON Data Type: Long
Output Level: 1
jobExecutionName
Description: Started job name
JSON Data Type: String
jobName
Description: Job name (maximum characters: 237)
JSON Data Type: String
startTime
Description: Start time if job has started or null if not started
JSON Data Type: String (with ISO 8601 UTC date format), for example: 2015-07-01T17:38:12Z
status
Description: Job status (maximum characters: 11), where possible values are listed in the Request Parameters section
JSON Data Type: String (with ISO 8601 UTC date format), for example: 2015-07-01T17:38:12Z
Priority
Description: Priority of the job if and when started (maximum characters: 11), where the value is one of the following:
  • UNSPECIFIED
  • LOW
  • MEDIUM
  • HIGH
JSON Data Type: String
submitTime
Description: Time when job was submitted
JSON Data Type: String
Output Level: 1

RESTful API Example (/datamover/executedJobs)

This example shows a started job, no jobs found, and an empty array.
[
     {
         "jobExecutionName" :  "successfulJob-20141204175020" ,
         "jobName" :  "successfulJob" ,
         "startTime" :"2015-07-01T17:38:12Z",
         "endTime" : "2015-07-01T19:38:12Z",
         "status" :  "COMPLETED" ,
         "priority" :  "MEDIUM" ,
         "links" : 
         [
             {
                 "rel" :  "status" ,
                 "href" :  "http://server/datamover/executedJobs/successfulJob-20141204175020"
                          
             }
            {
                 "rel" :  "job_steps" ,
                 "href" :  "http://server/datamover/jobs/successfulJob/steps"
                              
             }
         ]
     },
     {
         "jobExecutionName" :  "successfulJob-20141204175111" ,
         "jobName" :  "successfulJob" ,
         "startTime" : "2015-07-02T17:38:12Z",
         "endTime" : "2015-07-02T19:38:12Z",
         "status" :  "COMPLETED" ,
         "priority" :  "MEDIUM" ,
         "links" : 
         [
             {
                 "rel" :  "status" ,
                 "href" :  "http://server/datamover/executedJobs/successfulJob-20141204175111"
                          
             }
            {
                 "rel" :  "job_steps" ,
                 "href" :  "http://server/datamover/jobs/successfulJob/steps"
                              
             }
         ]
     },
     {
         "jobExecutionName" :  "failedJob-20141204175020" ,
         "jobName" :  "failedJob" ,
         "startTime" : "2015-07-03T17:38:12Z",
         "endTime" : "2015-07-03T19:38:12Z",
         "status" :  "FAILED" ,
         "priority" :  "MEDIUM" ,
         "links" : 
         [
             {
                 "rel" :  "status" ,
                 "href" :  "http://server/datamover/executedJobs/failedJob-20141204175020"
                          
             }
            {
                 "rel" :  "job_steps" ,
                 "href" :  "http://server/datamover/jobs/failedJob/steps"
                              
             }
         ]
     }
]     

Request Parameters (/datamover/executingJobs)

This variation returns all jobs currently running on the Data Mover daemon and started later than the specified time, where the value is one of the following:
  • INITIALIZING
  • RUNNING
  • BLOCKED
  • RESTARTING
  • QUEUED
You can provide the following optional parameters:
startTimeAfter
Description: Jobs started later than specified time
Restriction: Cannot be used with endTimeAfter
URL: /datamover/executingJobs
JSON Data Type: String (with ISO 8601 UTC date format), for example: 2015-07-01T17:38:12Z
Required: No
status
Description: Jobs with last run status that matches one of the following:
  • COMPLETED: All successfully completed jobs
  • FAILED: All failed jobs
  • CANCELLED: All user-cancelled jobs
URL: /datamover/executingJobs?status=value
JSON Data Type: String
Required: No

Response Parameters (/datamover/executingJobs)

jobExecutionName
Description: Started job name
JSON Data Type: String
jobName
Description: Job name (maximum characters: 237)
JSON Data Type: String
startTime
Description: Start time if job has been started or null if not started
JSON Data Type: String (with ISO 8601 UTC date format), for example: 2015-07-01T17:38:12Z
status
Description: Status of the job (maximum characters: 11), where possible values are specified in Request Parameters list
JSON Data Type: String
Priority
Description: Priority of the job if and when started (maximum characters: 11), where the value is one of the following:
  • UNSPECIFIED
  • LOW
  • MEDIUM
  • HIGH
JSON Data Type: String

RESTful API Example (/datamover/executingJobs)

This example shows a started job, no jobs found, and an empty array.
[
         {
         "jobExecutionName" :  "runningJob-1417744247669" ,
         "jobName" :  "runningJob" ,
         "startTime" :"2015-07-16T17:14:13Z",
         "status" :  "RUNNING" ,
         "priority" :  "MEDIUM" ,
         "links" : 
          [
             {
                 "rel" :  "status" ,
                 "href" :  "http://server/datamover/runningJobs/runningJob-1417744247669"
                          
             },
             {
                 "rel" :  "history" ,
                 "href" :  "http://server/datamover/executedJobs?jobName=runningJob&startTimeAfter=<value>"
                          
             }
            {
                 "rel" :  "job_steps" ,
                 "href" :  "http://server/datamover/jobs/runningJob/steps"
                              
             }
         ]
     }
] 

Request Parameters (/datamover/jobs?freezeJobStepsOnly=value)

freezeJobStepsOnly
Description: Jobs that have freeze job steps set to true
JSON Data Type: Boolean
Required: No
Accepted values: True or False
  • true = list jobs that have freeze job steps
  • false = return all jobs, regardless of freeze steps

Response Parameters (/datamover/jobs?freezeJobStepsOnly=value)

jobExecutionName
Description: Started job name
JSON Data Type: String
jobName
Description: Job name (maximum characters: 237)
JSON Data Type: String
links
Description: List of links to job status, past job executions, and job steps
JSON Data Type: JSON Array (LinkType )
Priority
Description: Priority of the job if and when started (maximum characters: 11), where the value is one of the following:
  • UNSPECIFIED
  • LOW
  • MEDIUM
  • HIGH
JSON Data Type: String
startTime
Description: Job start time
JSON Data Type: String (with ISO 8601 UTC date format), for example: 2015-07-01T17:38:12Z
status
Description: Status of job (maximum characters: 12), where possible values are specified in the Request Parameters description
JSON Data Type: String