URL:
https://<root>/System/RealitymappingTools/GPServer/AlterProcessingStates
Methods:
GET
Version Introduced:
12.2

Description

Alter Processing States diagram

The AlterProcessingStates operation is a service tool that sets the processing states of an image collection. The states are stored as the Reality 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

ParameterDetails

imageCollection

(Required)

The image collection whose processing states are altered. 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. The value must be valid JSON. Supported properties are blockadjustment , dem , gcp , seamlines , colorcorrection, imagetype and adjust_index. See table below for description of the supported properties.

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 | pjson

The following properties are supported in the newStates parameter:

PropertyDescriptionExample values
blockadjustmentThe block adjustment state of the image collection."raw", "Quick", "Full"
demThe method used to generate the DEM."Dense_Natural_Neighbor"
gcpThe ground control point state of the image collection.
seamlinesThe method used to generate seamlines."VORONOI", "Disparity"
colorcorrectionThe color correction method applied to the image collection."SingleColor"
imagetypeThe type of imagery in the image collection."UAV/UAS", "Unknown"
adjust_indexThe index of the block adjustment that is current for the image collection.0

Response

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

Syntax:

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

Use dark colors for code blocksCopy
1
https://<realitymapping 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
1
https://<realitymapping 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
1
https://organization.example.com/<context>/rest/services/System/RealitymappingTools/GPServer/AlterProcessingStates/submitJob

JSON request example

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

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.