Delete

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

Description

This operation removes jobs that have been completed or were canceled so that they no longer appear in queries or occupy server space.

Request parameters

ParameterDetails

jobIds

(Required)

The unique job identifier to add to the query URL, for example, ...jobs/delete/<jobID>.

f

(Required)

Specifies the response format.

Values: html | json | pjson

Response properties

The following details are for the properties of a response:

PropertyDetails

success

Indicates whether the operation was successful.

Values: true | false

JSON Response syntax

The following is the syntax of a response:

1
2
3
4
5
6
7
8
9
10
11
{
 "count": <the total amount of jobs to delete>,
 "results": [<array of JSON objects that represents submitted jobs>
  {
   "id": "<job ID>",
   "success": <true | false>,
   "message": "<informational or error messages>"
  }
 ],
 "success": <true | false>
}

Example usage

Delete a job using the jobId REST operation.

Request URL and parameters:

1
https://machine.domain.com/server/rest/services/MTM50/TopographicProductionServer/jobs/delete
1
2
jobId=1EC280F6-2D86-4B71-9C3F-4A2BF5B153D2
f=json

JSON Response example

The following response is an example of a successful deletion of one job:

1
2
3
4
5
6
7
8
9
10
11
{
 "count": 1,
 "results": [
  {
   "id": "1EC280F6-2D86-4B71-9C3F-4A2BF5B153D2",
   "success": true,
   "message": "Job deleted"
  }
 ],
 "success": true
}

Example usage

Delete multiple jobs using the jobId REST operation.

Request URL and parameters:

1
https://machine.domain.com/server/rest/services/MTM50/TopographicProductionServer/jobs/delete
1
2
3
4
5
6
jobId=[
"1EC280F6-2D86-4B71-9C3F-4A2BF5B153D2",
"4A2BF5B1-2D86-4B71-2D86-1EC280F653D2",
"F5B153D2-9C3F-4B71-9C3F-4A2B1EC280F6"
]
f=json

JSON Response example

The following example is a successful response to the delete REST operation when deleting multiple jobs:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
 "count": 3,
 "results": [
  {
   "id": "1EC280F6-2D86-4B71-9C3F-4A2BF5B153D2",
   "success": true,
   "message": "Job deleted"
  },
  {
   "id": "4A2BF5B1-2D86-4B71-2D86-1EC280F653D2",
   "success": true,
   "message": "Job deleted"
  },
  {
   "id": "F5B153D2-9C3F-4B71-9C3F-4A2B1EC280F6",
   "success": true,
   "message": "Job deleted"
  }
 ],
 "success": true
}

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