Alter Processing States

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

Description

The AlterProcessingStates operation is a service tool that sets the processing states of a mosaic dataset. The states are stored as the Ortho Mapping key property. The state's content is a JSON dictionary that includes several properties that can be set based on the processes run on the image collection.

Request parameters

Parameter Details

Parameter	Details
`imageCollection`	The 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: 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>”}`
`newStates` (Required)	The new states that are set on the image collection. Supported properties are `adjustment` , `dem` , `gcp` , `seamlines` , and `colorcorrection` . Use dark colors for code blocksCopy `1 2 3 4 5 6 {"blockadjustment": "raw", "dem": "", "seamlines": "", "colorcorrection": "", "adjust_index": 0, "imagetype": "Unknown"}`
`f`	The response format. The default response format is `html` . Values: `html \| json`

imageCollection

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

Use dark colors for code blocksCopy
{"itemId": “<portal item id>”}
{“url”: “<image service url>”}
{“uri”: “<cloud raster uri or shared data path>”}

newStates

(Required)

The new states that are set on the image collection. Supported properties are adjustment , dem , gcp , seamlines , and colorcorrection .

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

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>/AlterProcessingStates/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>/AlterProcessingStates/jobs/<jobID>/results/processingStates?token=<your token>&f=json

The result will be the newly set state's JSON.

Example usage

The following is a sample URL for AlterProcessingStates :

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

JSON request example

Use dark colors for code blocksCopy
imageCollection={"itemId": "1780d648db3545bba8661ad98df824a4"}&
newStates={"blockadjustment": "Full", "dem": "Dense_Natural_Neighbor", "seamlines": "Disparity", "colorcorrection": "SingleColor"}