Delete Image—ArcGIS REST APIs

URL:https://<rasteranalysistools-url>/DeleteImage
Version Introduced:10.6.1

Description

Delete Image diagram

The DeleteImage task allows you to remove existing images from the image collection. The service will only delete the raster item in the mosaic dataset and will not remove the source image.

License:

As of ArcGIS 10.5, you must license your ArcGIS Server as an ArcGIS Image Server to use this resource.

Request parameters


Parameter	Details
imageCollection (Required)	The image collection name or URL. The image collection must exist before calling this service to delete the images. Syntax: A JSON object supports three case sensitive keys: itemId, url, and uri. Example: `//Portal Item ID {"itemId": <portal item id>} //Image Service URL {"url": <image service url} //Service Properties {"serviceProperties":{"name":"testrasteranalysis", "serviceUrl":"https://<server name>/server/rest/services/Hosted/testrasteranalysis/ImageServer"}, "itemProperties":{"itemId":"8cfbd3ec25584d0d8f4ed23b8ff7c43b", "folderId", "sdfwerfbd3ec25584d0d8f4",: }}`
where (Required)	Use this SQL query to select images from the mosaic dataset. If all images are selected, all of them will be deleted from the mosaic dataset; however, the mosaic dataset (image collection) will not be deleted. Syntax: Standard syntax for SQL query Geoprocessing parameter. `"OBJECTID=10"`
f	The response format. The default response format is html. Values: html \| json

Response

When you submit a request, the task assigns a unique job ID for the transaction.

Syntax:

{
"jobId": "<unique job identifier>",
"jobStatus": "<job status>"
}

After the initial request is submitted, you can use jobId to periodically review the status of the job and messages as described in Checking job status. Once the job has successfully completed, use jobId to retrieve the results. To track the status, you can make a request of the following form:

https://<raster analysis tools url>/DeleteImage/jobs/<jobId>

When the status of the job request is esriJobSucceeded, you can access the results of the analysis by making a request of the following form:

https://<raster analysis tools url>/DeleteImage/jobs/<jobId>/results/result

Example usage

The following is a sample request URL for DeleteImage:

https://services.myserver.com/arcgis/rest/services/System/RasterAnalysisTools/GPServer/DeleteImage/submitJob

JSON Request example

imageCollection={"itemId": "780d648db3545bba8661ad98df824a4"}&
where="OBJECTID=10"

JSON Response example

The response returns the result parameter, which has properties for parameter name, data type, and value. The content of value is always the image service URL.

{
  "paramName": "result",
  "dataType": "GPString",
  "value": { 
     "url": "https://<server name>/arcgis/rest/services/Hosted/<server name>/ImageServer"
  }
}

ArcGIS REST APIs