ArcGIS REST API

Alter Processing States

Description

Alter Processing States diagram

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.

License:

As of ArcGIS 10.5, you must license your ArcGIS Server as an ArcGIS Image Server to use this resource.

Request parameters

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

Example:

{"itemId": <portal item id>}
{"url": <image service url}
{"serviceProperties":{"name":"testrasteranalysis",
  "serviceUrl":"https://<server name>/server/rest/services/Hosted/testrasteranalysis/ImageServer"},
  "itemProperties":{"itemId":"8cfbd3ec25584d0d8f4ed23b8ff7c43b", "folderId", "sdfwerfbd3ec25584d0d8f4",: }}

newStates

(Required)

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

{"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, you use the jobId to retrieve the results. To track the status, you can make a request of the following form:

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:

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:

https://services.myserver.com/arcgis/rest/services/System/OrthomappingTools/GPServer/AlterProcessingStates/submitJob

JSON request example

imageCollection={"itemId": "1780d648db3545bba8661ad98df824a4"}&
newStates={"blockadjustment": "Full", "dem": "Dense_Natural_Neighbor", "seamlines": "Disparity", "colorcorrection": "SingleColor"}