Delete Image

Description

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.

Request parameters

1
2
3
4
5
6
7
8
9
10
//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",: }}

1
"OBJECTID=10"

Response

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

Syntax:

1
2
3
4
{
"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:

1
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:

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

Example usage

The following is a sample request URL for DeleteImage :

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

JSON Request example

1
2
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.

1
2
3
4
5
6
7
{
  "paramName": "result",
  "dataType": "GPString",
  "value": {
     "url": "https://<server name>/arcgis/rest/services/Hosted/<server name>/ImageServer"
  }
}