Purpose
The delete_job RESTful API deletes the job definition and all instances of the job using the following URL and method:
| Item | Description | ||
|---|---|---|---|
| URL | /datamover/jobs/[job-name] | ||
| Method | DELETE | ||
Request Parameters
The delete_job RESTful API does not require specific request parameters.
Response Parameters
The delete_job RESTful API does not include specific response parameters.
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 Examples
{
"error":"job not found"
}
{
"error":"Job Definition [job-name] was not deleted because an instance of it is still running"
}