Purpose
The cleanup RESTful API deletes or cleans up an executed job using the following URL and method:
| Item | Description | ||
|---|---|---|---|
| URL | /datamover/executedJobs/[job-executed-name]?cleanupOnly=true | ||
| Method | DELETE | ||
Request Parameters
- cleanupOnly
- Description: Flag to run cleanup
Response Parameters
The cleanup 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":"invalid credential/not authorized to perform the delete action"
}
{
"error":"Job [job-executed-name] was not deleted because it is still running"
}