ArcGIS REST API

Edit Control Points

Edit Control Points diagram

The EditControlPoints operation is a service tool that is used to append additional ground control point sets to the image collection’s control points. A complete ground control point (GCP) set should have one ground control point and more than three tie points. The service tool can also be used to edit tie point sets.

The input control points JSON will always replace the points in the tie points table if the point IDs already exist.

Licensing

License:

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

This operation is supported at 10.6.1 and later.

Request URL

http://<Orthomapping service tool url>/EditControlPoints/submitJob?
imageCollection={"itemId": "1780d648db3545bba8661ad98df824a4"}&inputControlPoints={
{"geometry": {"x":-118.15,"y":33.80,"z":10.0,"spatialReference":{"wkid":4326}},  
"attributes": {"imageID":22, "pointID":2, "type":2, "status":1}}

Request parameters

The following table lists the parameters with syntax and details for each.

ParameterDescription

imageCollection

The image collection (mosaic dataset) name or url.

The image service must exist before calling the service to edit control points.

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>”}

inputControlPoints

(Required)

The existing GCP sets written as a JSON object.

Syntax: The schema of the control points JSON object follows the schema of the mosaic dataset control point table. The control points must contain one geometry and one attribute set. There could be two types of control points determined by the “type” attribute —1: tie points; 2: ground control points.

Example:

[
{
"pointId”: <id>,
“x”: 
”y”:
“z”:
“xyAccuracy”:
“zAccuracy”:
“spatialReference":{<spatialReference>}, // default WGS84
“imagePointSpatialReference”: {}, // default ICS
“imagePoints”: [
{“imageId”: 
 “x”:
     “y”: 
    },
   …
   ]
}
]
Note:

The control point sets provided in this tool will replace the control points in the existing control points table, if they already exist.

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

http://<Orthomapping service tool url>/EditControlPoints/jobs/<jobId>

Accessing results

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:

http://<Orthomapping service tool url>/EditControlPoints/jobs/<jobId>/results/result?token=<your token>&f=json

The result will be the image collection URL.