Skip to content
URL:
https://<rasteranalysistools-url>/DefineNodata
Methods:
GETPOST
Version Introduced:
10.7

Description

The DefineNodata operation specifies one or more values to be represented as NoData.

Request parameters

ParameterDetails

inputRaster

(Required)

The input raster, specified by either an item ID, image service URL, cloud raster dataset, or shared raster dataset.

Syntax: JSON object describes the input raster. At least one type of input needs to be provided in the JSON object. If multiple inputs are given, itemId will take priority.

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

nodata

(Required)

Specify the NoData value for each band. Each band can have a unique NoData value defined, specify a range of values displayed for each band, or you can use the same value for all bands. If a range of values are provided, values outside of this range will be classified as NoData. When working with composite bands, the range will apply to all bands. For more information, see documentation on NoData values.

Example:

Use dark colors for code blocksCopy
1
2
3
4
5
{"noDataValues": [0]}

{"noDataValues": [0, 255, 0]}

{"includedRanges": [0, 255]}

queryFilter

(Optional)

A SQL statement to select a specific raster in the mosaic dataset. Only the selected rasters will have their NoData values updated.

numOfBands

(Optional)

The number of bands in the mosaic dataset. The default value is Null.

compositeValue

(Optional)

Specifies whether all bands must be NoData for the pixel to be classified as NoData. Default is Null.

f

The response format. The default format is html.

Values: html | json | pjson

Example usage

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

Use dark colors for code blocksCopy
1
https://organization.example.com/<context>/rest/services/System/RasterAnalysisTools/GPServer/DefineNodata/submitJob?inputRaster={"itemId":"51f2e556092a4e098b5d05b4b0ad94e7"}&nodata={"noDataValues":[0]}&compositeValue=true&f=pjson

JSON Response example

The response returns the outputRaster 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
1
2
3
4
5
6
7
{
    "paramName": "outputRaster",
    "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
1
{ "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
1
https://<raster analysis tools url>/DefineNodata/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://<raster analysis tools url>/DefineNodata/jobs/<jobId>/results/outputRaster

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