ArcGIS REST API

Get Processing States

Description

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

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 get the processing states.

Syntax: A JSON object supports three keys, itemId, url and uri. These keys are case sensitive.

Example:

{"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:

{
"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>/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:

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:

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

JSON request example

imageCollection={"itemId": "1780d648db3545bba8661ad98df824a4"}