- URL:
- https://<root>/services/<serviceName>.<serviceType>/jobs/<jobID>/cancel
- Methods:
POST- Version Introduced:
- 10.6.1
Access requirements
Required privileges
The Sever Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Note that administrators assigned a custom role must also have the administrative View all content privilege assigned to them to access the API directory as an administrator.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Server Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Portal Directory API. For security reasons, all POST requests made to the Server Administrator API must include a token in the request body.
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 /<context>/admin/services/RasterUtilities.GPServer/jobs/j290c2d4e60364xx2a0c735fb9b68428a/cancel HTTP/1.1
Host: organization.example.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
}