status RESTful API - Teradata Data Mover

Teradata Data Mover User Guide
Product
Teradata Data Mover
Release Number
16.00
Published
December 2016
Language
English (United States)
Last Update
2018-03-29
dita:mapPath
rdo1467305237457.ditamap
dita:ditavalPath
ft:empty
dita:id
B035-4101
lifecycle
previous
Product Category
Analytical Ecosystem

Overview

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

Item Description
URL /datamover/jobs
Method GET

Request Parameters

status
URL: /datamover/jobs?status=<value>
Description: jobs with execution that matches one of the following status options:
  • 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
Required: No

Response Parameters

jobExecutionName
Description: Job execution name
JSON Data Type: String
jobName
Description: Job name (maximum characters: 237)
JSON Data Type: String
startTime
Description: start time
JSON Data Type: long
endTime
Description: end time if job has executed or null if not executed
JSON Data Type: long
status
Description: Status of the job (maximum characters: 12), where possible values are listed in in the status description for Request Parameters
JSON Data Type: string
priority
Description: Priority of the job if and when executed (maximum characters: 11), where the value is one of the following:
  • UNSPECIFIED
  • LOW
  • MEDIUM
  • HIGH
JSON Data Type: string

Status Codes

If the command executes without error, the API returns status code 200 in the response header and nothing in the response body.

If an error occurs during execution, the API returns a non-200 status code in the response header and an error message in JSON format in the response body.

Response Example

This example shows an array of job executions with the most common status. The links generated depend on job status.
[
    {
        "jobName": "newJob",
        "startTime": null,
        "endTime": null,
        "status": "NEW",
        "priority": "MEDIUM"
    },
    {
        "jobName": "runningJob",
        "startTime": 1417744247669,
        "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"
            }
        ]
    },
    {
        "jobName": "successfulJob",
        "startTime": 1417744247669,
        "endTime": 1417744323437,
        "status": "COMPLETED",
        "priority": "MEDIUM",
        "links":
        [
            {
                "rel": "status",
                "href": "http://server/datamover/executedJobs/successfulJob-20141204175020"
            },
            {
                "rel": "past_executions",
                "href": "http://server/datamover/executedJobs?jobName=successfulJob"
            }
        ]
    },
    {
        "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"
            }
        ]
    }
]
Related information