ArcGIS REST API

Query Control Points

Description

Query Control Points diagram

The QueryControlPoints operation is a service tool that allows users to use a SQL query to query certain control points from the image collection's control point table.

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 image collection (mosaic dataset) name or URL. The image service must exist before calling the service to query.

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",: }}

where

(Required)

The SQL query definition used to filter results based on the control points' table attributes.

PointID>2535
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>/QueryControlPoints/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>/QueryControlPoints/jobs/<jobId>/results/outControlPoints?token=<your token>&f=json

The response will be the control point's JSON file.

Example usage

Below is a sample URL for QueryControlPoints.

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

JSON request example

imageCollection={"itemId": "1780d648db3545bba8661ad98df824a4"}&
where="PointID>2535"