Get Processing States

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

Description

The GetProcessingStates operation is a service tool that obtains the processing states of the image collection (mosaic dataset) in JSON.

Request parameters

Parameter Details

Parameter	Details
`imageCollection`	The mosaic dataset name or URL. The image service must exist before calling the service to get 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>”}`
`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 get 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>”}

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

This result will be the processing state's JSON.

Example usage

The following is a sample URL for GetProcessingStates :

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

JSON request example

Use dark colors for code blocksCopy
imageCollection={"itemId": "1780d648db3545bba8661ad98df824a4"}