ArcGIS REST API

Generate Report

Description

Generate Report diagram

The GenerateReport operation is a service tool that generates an Ortho Mapping report with an image collection that has been block adjusted. The report contains information about the quality of the adjusted images, the distribution of the control points, and more. The output of this service tool is a downloadable HTML page.

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 generate a report.

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

f

The response format. The default response format is html.

Contains additional settings that affect task execution.

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

The result will be an HTML web page containing a formatted Ortho Mapping report.

Example usage

The following is a sample URL for GenerateReport:

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

JSON request example

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