Cancel Job

  • URL:https://server:port/arcgis/admin/services/[<folder>]/<serviceName.serviceType>/jobs/<jobID>/cancel(POST only)
  • Related Resources:Delete Job
  • Version Introduced:10.6.1

Description

This 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 GP Job operation in the ArcGIS Server Services Directory performs the same function.

This 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

JSON response example

The job was successfully cancelled.

{
  "status": "success"
}

The job cannot be cancelled due to its status.

{
  "status": "error",
  "messages": ["Unable to cancel job :[<jobID>]"],
  "code": 500
}