- URL:
- https://<root>/System/RealitymappingTools/GPServer/AlterProcessingStates
- Methods:
GET- Version Introduced:
- 12.2
Description
The Alter 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
| Parameter | Details |
|---|---|
(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: Example: |
(Required) | The new states that are set on the image collection. The value must be valid JSON. Supported properties are |
|
The response format. The default response format is Values: |
The following properties are supported in the new parameter:
| Property | Description | Example values |
|---|---|---|
blockadjustment | The block adjustment state of the image collection. | "raw", ", " |
dem | The method used to generate the DEM. | " |
gcp | The ground control point state of the image collection. | |
seamlines | The method used to generate seamlines. | ", " |
colorcorrection | The color correction method applied to the image collection. | " |
imagetype | The type of imagery in the image collection. | ", " |
adjust | The 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:
{
"jobId": "<unique job identifier>",
"jobStatus": "<job status>"
}After the initial request is submitted, you can use job to periodically review the status of the job and messages as described in Checking job status. Once the job has successfully completed, use job to retrieve the results. To track the status, you can make a request of the following form:
https://<realitymapping tools url>/AlterProcessingStates/jobs/<jobID>When the status of the job request is esri , you can access the results of the analysis by making a request of the following form:
https://<realitymapping tools url>/AlterProcessingStates/jobs/<jobID>/results/processingStates?token=<your token>&f=jsonThe result will be the newly set state's JSON.
Example usage
The following is a sample URL for Alter :
https://organization.example.com/<context>/rest/services/System/RealitymappingTools/GPServer/AlterProcessingStates/submitJobJSON request example
imageCollection={"itemId": "1780d648db3545bba8661ad98df824a4"}&
newStates={"blockadjustment": "Full", "dem": "Dense_Natural_Neighbor", "seamlines": "Disparity", "colorcorrection": "SingleColor"}