URL:
https://<root>/System/RealitymappingTools/GPServer/CreateMission
Methods:
GET
Version Introduced:
12.2

Describe

The CreateMission operation is a service tool that creates a Reality Mapping mission. A Reality Mapping mission contains the information (e.g., mission name, image collection, products etc.) that defines a Reality Mapping mission.

Request parameters

ParameterDetails

projectItem

(Required)

The item ID for the Reality Mapping project item under which to create mission.

Syntax: JSON object.

Use dark colors for code blocksCopy
1
{"itemId": "<portal item id>"}

missionDefinition

(Required)

The object definition for the Reality Mapping mission item that will be created.

Example:

Use dark colors for code blocksCopy
1
2
3
4
5
6
{"name": "Mission 1",
 "settings": {"sensorType":"Drone",
            "scenarioType":"DRONE",
            "adjustSettings":{},
            "outputProducts": ["dsm", "dtm", "ortho", "trueOrtho", "pointCloud"],
            "processingSettings":{}}}

inputRasters

(Required)

The portal folder ID, portal item ID, image service URL, cloud raster dataset, or shared raster dataset that will be added to the image collection. At least one type of input must be provided in the JSON object. If multiple inputs are given, the itemId takes priority.

Syntax: A JSON object describes the input raster.

Use dark colors for code blocksCopy
1
2
3
4
{"folderId": <portal folder id>}
{"itemIds": [<portal item id>, <portal item id>, <portal item id>]}
{"urls": [<image service url>, <image service url>, <image service url>]}
{"uris": [<cloud raster uri or shared data path>, <cloud raster uri or shared data path>]}

The byref value is supported in cases where data will not be uploaded and the input JSON object contains the byref key set to true .

Use dark colors for code blocksCopy
1
2
3
//Single item
{"url": <single cloud raster url>, "byref": true}
{"uri": <single mosaic dataset unc path>, "byref": true}

When setting the input raster dataset, a relative data store path is supported such as /fileshare/a/a.tif or /cloudStore/B/b.crf through the "uri" key. The "uri" key can also be used to set an input mosaic dataset, and the mosaic dataset will not be copied to the raster store. When setting the input raster dataset stored in the cloud storage by reference, the cloud storage bucket must be open to the public. The syntax does not support a secured bucket.

Use dark colors for code blocksCopy
1
2
3
//Multiple items
{"uris": [<single rd unc path>, <single rd unc path>, <single rd unc path>], "byref": true}
{"urls": [<single cloud raster url>, <single cloud raster url>, <single cloud raster url>], "byref": true}

The byvalue value is supported in cases where the byref tag is not give or is set to false , and the input raster data or mosaic dataset will be uploaded or copied to the raster store.

Use dark colors for code blocksCopy
1
2
3
4
5
//Single item
{"folderId": <folder id>}
{"itemId": <upload item id>}
{"url": <single cloud raster url>}
{"uri": <single md path or rd unc path>}

When a mosaic dataset is given as input, the mosaic dataset is copied to the raster store but not the source image it references. The server should also be granted access to the location of the source image. If the raster store only has a file share, the mosaic dataset is copied to the file geodatabase created in the file share. If the raster store has a database, the mosaic dataset is copied to the database.

imageCollection

(Required)

The output image collection name or URL. As with raster analysis services, the service can be an existing multitenant service URL, or this service tool can create it. If the image collection is created by the service tool, it will be created in the geodatabase. The geodatabase could either be a file geodatabase in the file share type of raster store or an enterprise database configured as raster store.

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

Example:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
//Portal Item ID
{"itemId": <portal item id>}

//Image Service URL
{"url": <image service url}

//Service Properties
{"serviceProperties":{"name":"testrasteranalysis",
  "serviceUrl":"https://<server name>/server/rest/services/Hosted/testrasteranalysis/ImageServer"},
  "itemProperties":{"itemId":"8cfbd3ec25584d0d8f4ed23b8ff7c43b", "folderId", "sdfwerfbd3ec25584d0d8f4",: }}

rasterType

(Required)

The raster type that will be used to add images to the image collection.

Syntax: A JSON object describes the raster type, which can be used to set properties of the raster types. The supported raster types keywords in JSON are UAV/UAS , ScannedAerial , Landsat 7 ETM + , Landsat 8 Sentinel-2 , ZY3-SASMAC , and ZY3-CRESDA .

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
{"rasterTypeName": "UAV/UAS",
 "rasterTypeParameters": {
   "gps": [["image1.jpg", "10", "2", "300"], ["image2.jpg", "10", "3", "300"]],
   "cameraProperties": {"Maker": "Canon", "Model": "5D Mark II", "FocalLength": 20, "PixelSize": 10, "x0": 0, "y0": 0, "columns": 4000, "rows": 3000},
   "constantZ": 300,
   "isAltitudeFlightHeight": "true",
   "dem": {"url": "https://..."}
 }
}

context

Contains additional settings that affect task execution. The following setting is available:

Output Spatial Reference (outSR ) - The image collection will be projected into the output spatial reference. The outSR setting is required if you want the service to create the mosaic dataset and hosted image service.

Use dark colors for code blocksCopy
1
{"outSR": {spatial reference}}

f

The response format. The default response format is html.

Values: html | json | pjson

Response

When you submit a request, the task assigns a unique job ID for the transaction.

Syntax:

Use dark colors for code blocksCopy
1
2
3
4
{
"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
1
https://<realitymapping tools url>/CreateMission/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
1
https://<realitymapping tools url>/CreateMission/jobs/<jobId>/results/outProducts?token=<your token>&f=json

Example usage

The following is a sample URL for CreateMission :

Use dark colors for code blocksCopy
1
https://services.myserver.com/arcgis/rest/services/System/RealitymappingTools/GPServer/CreateMission/submitJob

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.