ArcGIS REST API

Reset Image Collection

Description

The ResetImageCollection operation is a service tool that resets the image collection to its original state. Resetting the image collection includes removing the block adjustment that's computed for the images, rebuilding the footprints, and removing seamlines and mosaic candidates. The image collection can be adjusted during the Ortho Mapping workflow. If you're not satisfied with the result, you can clear any existing adjustment settings and return the images to an unadjusted state.

License:

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

Request parameters

ParameterDetails
imageCollection

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

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

Example:

{"itemId": <portal item id>}
{"url": <image service url}
{"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

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, you use the jobId to retrieve the results. To track the status, you can make a request of the following form:

https://<orthomapping tools url>/ResetImageCollection/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://<orthomapping tools url>/ResetImageCollection/jobs/<jobId>/results/result?token=<your token>&f=json

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

Example usage

The following is a sample URL for ResetImageCollection:

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