Build Overview | ArcGIS REST APIs

URL:: https://<rasteranalysistools-url>/BuildOverview
Methods:: GETPOST
Version Introduced:: 10.7

Description

The BuildOverview operation defines and generates overviews on an existing image collection.

Request parameters

Parameter Details

Parameter	Details
`imageCollection` (Required)	The output image collection (mosaic dataset) name or URL. The image service must exist before performing this operation. Syntax: A JSON object that that includes either the `itemId`, `url` or `uri` property. The properties are case sensitive. Example: Use dark colors for code blocksCopy `1 2 3 {"itemId": "<portal item id>"} {"url": "<image service url>"} {"uri": "<cloud raster uri or shared data path>"}`
`cellSize` (Optional)	Set the overview cell size or resolution for the operation. Default is `Null`. Value must be greater than 0. Example Use dark colors for code blocksCopy `1 cellSize=0.3`
`context` (Optional)	Contains additional settings that affect task execution. This task currently supports `parallelProcessingFactor`, which specifies the number of processes across which a tool will spread its operation. `parallelProcessingFactor`: The number of processes across which a tool will spread its operation.
`f`	The response format. The default format is `html`. Values: `html` \| `json` \| `pjson`

imageCollection

(Required)

The output image collection (mosaic dataset) name or URL. The image service must exist before performing this operation.

Syntax: A JSON object that that includes either the itemId, url or uri property. The properties are case sensitive.

Example:

Use dark colors for code blocksCopy
      {"itemId": "<portal item id>"}
      {"url": "<image service url>"}
      {"uri": "<cloud raster uri or shared data path>"}

cellSize

(Optional)

Set the overview cell size or resolution for the operation. Default is Null. Value must be greater than 0.

Example

Use dark colors for code blocksCopy
cellSize=0.3

context

(Optional)

Contains additional settings that affect task execution. This task currently supports parallelProcessingFactor, which specifies the number of processes across which a tool will spread its operation.

parallelProcessingFactor: The number of processes across which a tool will spread its operation.

f

The response format. The default format is html.

Values: html | json | pjson

Example usage

The following is a sample request URL for the BuildOverview operation:

Use dark colors for code blocksCopy
https://organization.example.com/<context>/rest/services/System/RasterAnalysisTools/GPServer/BuildOverview/submitJob?imageCollection={"itemId":"51f2e556092a4e098b5d05b4b0ad94e7"}&f=pjson

JSON Response example

The response returns the outputCollection output parameter, which has properties for parameter name, data type, and value. The content of the value is always the output raster dataset’s itemId and image service URL.

Use dark colors for code blocksCopy
{
    "paramName": "outputCollection",
    "dataType": "GPString",
    "value": [{
        "url": "https://<server url>/arcgis/rest/services/Hosted/Hosted_mosaic_image_collection/ImageServer"
    }]
}

Response

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

Syntax:

Use dark colors for code blocksCopy
{ "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 Check 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:

Use dark colors for code blocksCopy
https://<raster analysis tools url>/BuildOverview/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
https://<raster analysis tools url>/BuildOverview/jobs/<jobId>/results/outputCollection