- 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 jobs submitted to the server. It returns a standard REST success or error message.
Request parameters
Parameter | Details |
---|---|
(Required) | The unique job identifier to add to the query URL, for example, |
(Required) |
Specifies the response format. Values: |
Example usage
Cancel a job using the cancel
REST operation:
Request URL and parameters:
https://organization.example.com/<context>/rest/services/Test/TopographicProductionServer/jobs/cancel
f=json
jobId=j12fd478e78d042e88a34f08a4836fb73
JSON Response syntax
The following is the syntax of a response for a single job:
{
"count": <number of jobs>,
"name": "<name of the operation>"
"items": [
{
"id": "<job ID>",
"success": <true | false>,
"message": "<message>"
}
],
"success": <true | false>
}
JSON Response example
The following is an example of a successful response for a single job:
{
"count": 1,
"name": "canceled"
"items": [
{
"id": "2FE148F3-EFC8-4C7C-A40F-2A900CF99F09",
"success": true,
"message": "Job canceled"
}
],
"success": true
}
JSON Response syntax
The following is the syntax of a response for multiple jobs:
{
"count": <number of jobs>,
"name": "<name of the operation>"
"items": [
{
"id": "<job ID>",
"success": <true | false>,
"message": "<message>"
},
{
"id": "<job ID>",
"success": <true | false>,
"message": "<message>"
}
],
"success": <true | false>
}
JSON Response example
The following is an example of a successful response for multiple jobs:
{
"count": 2,
"name": "canceled",
"items": [
{
"id": "2EF147F3-EAC8-1M7N-Z20L-7A988CF99G13",
"success": true,
"message": "Job canceled"
},
{
"id": "3FA149K3-EYC8-4B5C-A90H-2A911CF94R02",
"success": true,
"message": "Job canceled"
}
],
"success": true
}