Cancel

URL:
https://<root>/<serviceName>/TopographicProductionServer/jobs/cancel
Methods:
GET
Required Capability:
Requires an ArcGIS GIS Server Advanced license and a Production Mapping or Defense Mapping server extension license
Version Introduced:
10.9

Description

The cancel operation cancels a job submitted through the generateProduct REST operation. It returns a standard REST success or error message.

Request parameters

ParameterDetails

jobId

(Required)

The unique job identifier to add to the query URL, for example, ...jobs/cancel?jobId=<jobID>.

f

(Required)

Specifies the response format.

Values: html | json | pjson

Example usage

Cancel a job using the cancel REST operation:

Request URL and parameters:

Use dark colors for code blocksCopy
1
https://machine.domain.com/server/rest/services/Test/TopographicProductionServer/jobs/cancel
Use dark colors for code blocksCopy
1
2
f=json
jobId=j12fd478e78d042e88a34f08a4836fb73

JSON Response syntax

The following is the syntax of a response:

Use dark colors for code blocksCopy
1
2
3
{
"success" : <true | false>
}

JSON Response example

The following is an example of a successful response:

Use dark colors for code blocksCopy
1
2
3
{
 "success": true
}

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