Description
This operation removes jobs that have been completed or were canceled so that they no longer appear in queries or occupy server space.
Request parameters
| Parameter | Details |
|---|---|
(Required) | The unique job identifier to add to the query URL, for example, |
(Required) |
Specifies the response format. Values: |
Response properties
The following details are for the properties of a response:
| Property | Details |
|---|---|
| Indicates whether the operation was successful. Values: |
Example usage
The following URL queries the products in the Topographic Production Service resource by job, removes the associated job, and returns a response in JSON format:
https://machine.domain.com/server/rest/services/MTM50/TopographicProductionServer/jobs/delete?jobId=1EC280F6-2D86-4B71-9C3F-4A2BF5B153D2&f=jsonJSON Response syntax
The following is the syntax of a response:
{
"count": <the total amount of jobs to delete>,
"results": [<array of JSON objects that represents submitted jobs>
{
"id": "<job ID>",
"success": <true | false>,
"message": "<informational or error messages>"
}
],
"success": <true | false>
}JSON Response example
The following response is an example of a successful deletion of one job:
{
"count": 1,
"results": [
{
"id": "E55089F9-D756-453F-B700-D1D72FE79BA9",
"success": true,
"message": "Job deleted"
}
],
"success": true
}