Alter Processing States

Alter Processing States diagram

The AlterProcessingStates operation is a service tool that's used to set the processing states of an image collection (mosaic dataset). The states are stored as the key property Orthomapping. The content of the state is a JSON dictionary including several properties that can be set based on the processes run on the image collection.

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://<orthomapping service tool url>/AlterProcessingStates/submitJob?
imageCollection={"itemId": "1780d648db3545bba8661ad98df824a4"}&
newStates={“blockadjustment”: “Full”, “dem”: “Dense_Natual_Neighbor”, 
“seamlines”: “Disparity”, “colorcorrection”: “SingleColor”}

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 service must exist before calling the service to set the processing states.

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

newStates

(Required)

The new states need to be set on the image collection. For the 10.6.1 release, the supported properties are the following:

[“adjustment”, “dem”, “gcp”, “seamlines”, “colorcorrection”]

Example :

{"blockadjustment": "raw",
 "dem": "",
"seamlines": "",
"colorcorrection": "",
"adjust_index": 0,
"imagetype": "Unknown"}

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://<Orthomapping service tool url>/AlterProcessingStates/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://<Orthomapping service tool url>/AlterProcessingStates/jobs/<jobId>/results/processingStates?token=<your token>&f=json

The result will be the newly set states JSON.