Delete Job | RESTful API | Teradata Data Mover - 17.11 - Delete Job (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 options when deleting jobs:
  • Delete a job definition and all instances of the job
  • Delete only the job instances without deleting the job definition

The following URL and methods are available for deleting jobs:

Item Description
URL

/datamover/jobs/job-name

/datamover/jobs/job-name?definition=value

Method DELETE

Request Parameters

definition
Description: Flag to delete job instance only without job definition
Required: No
Accepted Values: True or False
Default value is true when no value is entered.
  • True = delete job definition and job instance
  • False = delete only job instance

Response Parameters

No response parameters required.

Response Examples

{
    "error":"job not found"
}
{
    "error":"Job Definition [job-name] was not deleted because an instance of it is still running"
}