ArcGIS REST API

Delete Image

Delete Image diagram

The DeleteImage operation is a service that allows you to remove existing images from the image collection (mosaic dataset). The service will only delete the raster item in the mosaic dataset and will not remove the source image.

Licensing

License:

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

This operation is supported at 10.6.1 and later.

Request URL

http://<raster analysis service tool url>/DeleteImage/submitJob?
imageCollection={"itemId": "780d648db3545bba8661ad98df824a4"}&
where="OBJECTID=10"

Request parameters

The following table lists the parameters with syntax and details for each.

ParameterDescription

imageCollection

The image collection (mosaic dataset) name or URL. The image collection must exist before calling this service to delete the images.

Syntax: A JSON object supports three keys, itemId, url and uri. These keys are case sensitive.

Example:

{"itemId": “<portal item id>”}
{“url”: “<image service url>”}
{“uri”: “<cloud raster uri or shared data path>”}

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 service) will not be deleted.

Syntax: Standard syntax for SQL query Geoprocessing parameter.

Example:

“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 the jobId to periodically check the status of the job and messages as described in Checking job status. Once the job has successfully completed, use the jobId to retrieve the results. To track the status, you can make a request of the following form:

http://<raster analysis service tool url>/DeleteImage/jobs/<jobId>

Accessing results

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:

http://<raster analysis url>/DeleteImage/jobs/<jobId>/results/result?token=<your token>&f=json

ParameterDescription

result

The output image collection item ID and URL.

Examples:

{"url": 
"http://<raster analysis url>/DeleteImage/jobs/<jobId>/results/result"}

The result has properties for parameter name, data type, and value. The content of value is always the image service URL. For example:

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