- URL:
- https://<root>/services/<serviceName>.<serviceType>/jobs/<jobID>/cancel
- Methods:
POST- Required Capability:
- Access allowed only with the default administrator role
- Version Introduced:
- 10.6.1
Description
The cancel operation cancels the asynchronous job being run by the geoprocessing service. The operation can only succeed if the current status of the job is SUBMITTED or EXECUTING. If the job currently carries a different status, an error of Unable to cancel job will be returned. The cancel operation does not remove any information about the job from the service. To cancel a job and remove information about the job from the service, use the Delete Job operation.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default response format is Values: |
Example usage
The following is a sample POST request for the cancel operation:
POST /webadaptor/admin/services/RasterUtilities.GPServer/jobs/j290c2d4e60364xx2a0c735fb9b68428a/cancel HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
f=pjsonJSON Response example
Success response
The job was successfully cancelled
{"status": "success"}Error response
The job cannot be cancelled due to its status
{
"status": "error",
"messages": ["Unable to cancel job :[<jobID>]"],
"code": 500
}