Reset Image Collection

URL:: https://<root>/System/OrthomappingTools/GPServer/ResetImageCollection
Methods:: GET
Version Introduced:: 10.6.1

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.

Request parameters

Parameter Details

Parameter	Details
`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 keys: itemId, url, and uri. These keys are case sensitive. Example: Use dark colors for code blocksCopy `1 2 3 {"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`

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 keys: itemId, url, and uri. These keys are case sensitive.

Example:

Use dark colors for code blocksCopy
{"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:

Use dark colors for code blocksCopy
{
"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:

Use dark colors for code blocksCopy
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:

Use dark colors for code blocksCopy
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 :

Use dark colors for code blocksCopy
https://services.myserver.com/arcgis/rest/services/System/OrthomappingTools/GPServer/submitJob