Cancel Job

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

ParameterDetails

f

The response format. The default response format is html.

Values: html | json | pjson

Example usage

The following is a sample POST request for the cancel operation:

1
2
3
4
5
6
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=pjson

JSON Response example

Success response

The job was successfully cancelled

1
{"status": "success"}

Error response

The job cannot be cancelled due to its status

1
2
3
4
5
{
  "status": "error",
  "messages": ["Unable to cancel job :[<jobID>]"],
  "code": 500
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close