Delete Image Collection—REST APIs | Documentation for ArcGIS Enterprise

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

Description

The DeleteImageCollection task deletes 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.

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

Parameter	Details
imageCollection (Required)	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 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",: }}`
f	The response format. The default response format is html. Values: html \| json

imageCollection

(Required)

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 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",: }}

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>/DeleteImageCollection/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>/DeleteImageCollection/jobs/<jobId>/results

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

Example usage

The following is a sample request URL for DeleteImageCollection:

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

Feedback on this topic?

Description

License:

Request parameters

Response

Example usage

In this topic