ArcGIS REST API

Delete Image Collection

Delete Image Collection diagram

The DeleteImageCollection operation is a service tool that's used to delete the image collection image service, that is, the portal-hosted image layer item. It will not delete the source images that the image collection references.

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>/DeleteImageCollection/submitJob?
imageCollection={"itemId": "1780d648db3545bba8661ad98df824a4"}

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>”}

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>/DeleteImageCollection/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>/DeleteImageCollection/jobs/<jobId>/results/result?token=<your token>&f=json

The result will be a Boolean value indicating whether the deletion was successful.