(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 needs to be provided in the JSON object.

Syntax: A JSON object describes the input multidimensional raster.

inputMultidimensionalRaster={"folderId": "<portal folder id>"}
inputMultidimensionalRaster={"itemId": "<portal item id>"}
inputMultidimensionalRaster={"url": "<image service url>"}
inputMultidimensionalRaster={"uri": "<cloud raster uri or shared data path>"}

(Required)

The output image collection name or URL. The image service must exist before you add the images. If the hosted image service is already created, the portal item ID or service URL can be given to the service tool. The output path of the raster dataset generated in the raster store will be used to update the existing service definition. The service tool can also generate a new hosted image service with the given service properties. The output hosted image service is stored in a raster store and shared on either the Raster Analysis Image Server or Image Hosting Image Server depending on the Enterprise configuration.

Syntax: A JSON object describes the output multidimensional or multiband raster.

outputName={"folderId": <portal folder id>}
outputName={“url”: <image service url>}
outputName={“uri”: <cloud raster uri or shared data path>}
or
outputName={"serviceProperties": {“name”:”watertemp_anomaly”, ”capabilities”: ”image, metadata”}}

At least one type of input needs to be provided in the JSON object.

The variable or variables to be analyzed. If the input raster is not multidimensional, the pixel values of the multiband raster are considered the variable. If the input raster is multidimensional and no variable is specified, all variables with the selected dimension will be analyzed.

For example, to find the years in which temperature values were highest, specify temperature as the variable to be analyzed. If you do not specify any variables and you have both temperature and precipitation variables, both variables will be analyzed, and the output multidimensional raster will include both variables.

Syntax: A list containing the variables.

variables=["temp","salinity"]

Specifies the dimension interval for which the data will be analyzed.

• ALL—The data values will be analyzed across all slices. This is the default.
• BY_RANGES—The dimension will be sliced using a range or a list of ranges.
• BY_ITERATION—The dimension will be sliced over a specified interval size.
• BY_VALUE—The dimension will be sliced using a list of dimension values.

Syntax: A string representing the method.

dimensionDefinition="BY_VALUE"

This slices the data based on the dimension name and the minimum and maximum values for the range. This parameter is required when the dimensionDefinition parameter is set to BY_RANGES. If dimension is StdTime, the value must be specified in a readable time format (YYYY-MM-DDTHH:MM:SS).

Syntax: a list of dictionary objects.

dimensionRanges=[{“dimension”:”<dimension name>”,"minValue":"<min value>","maxValue":"<max value>"},{“dimension”:”<dimension name>”,"minValue":"<min value>","maxValue":"<max value>"}]

dimensionRanges=[{"dimension":"StdTime",“minValue":"2013-05-17T00:00:00","maxValue":"2013-05-17T03:00:00"},{"dimension":"StdZ", "minValue":"-5000","maxValue":"-4000"}]

This slices the data based on the dimension name and value.

This parameter is required when the dimensionDefinition parameter is set to BY_VALUE.

If dimension is StdTime, the value must be specified in a readable time format (YYYY-MM-DDTHH:MM:SS).

Syntax: a list of dictionary objects.

dimensionValues=[{"dimension":"<dimension name>", "value":"<value>”},{"dimension":"<dimension name>", "value":"<value>"}]

dimensionValues=[{"dimension":"StdTime", "value":"2012-01-15T03:00:00"},{"dimension":" StdZ ", "value":"-4000"}]

The dimension along which the variables will be sliced.

Syntax: A string representing the dimension name.

dimension="StdTime"

The beginning of the first interval. This interval is used to iterate through the dataset. This parameter is required when the dimensionDefinition parameter is set to BY_ITERATION.

Syntax: a string representing the start of the first iteration.

startOfFirstIteration="1990-01-01T00:00:00"

The end of the first interval. This interval is used to iterate through the dataset. This parameter is required when the dimensionDefinition parameter is set to BY_ITERATION.

Syntax: a string representing the end of the first iteration.

endOfFirstIteration="1990-01-02T00:00:00"

The frequency with which the data will be sliced. This parameter is required when the dimensionDefinition parameter is set to BY_ITERATION.

Syntax: A double value.

iterationStep=2

Specifies the iteration unit. This parameter is required when the dimensionDefinition parameter is set to BY_ITERATION.

• HOURS—Hours is the specified unit of time.
• DAYS—Days is the specified unit of time.
• WEEKS—Weeks is the specified unit of time.
• MONTHS—Months is the specified unit of time.
• YEARS—Years is the specified unit of time.

Syntax: A string representing the iteration unit.

iterationUnit="MONTHS"

Contains additional settings that affect task execution. This task has the following settings:

• Extent (extent)—A bounding box that defines the analysis area.
• Output Spatial Reference(outSR)—The output raster will be projected into the output spatial reference.
• Snap Raster (snapRaster)—The output raster will have its cells aligned with the specified snap raster.
• Cell Size (cellSize)—The output raster will have the resolution specified by cell size.
• Parallel Processing Factor (parallelProcessingFactor)—The specified number or percentage of processes will be used for the analysis.

The response format. The default response format is html.

Values: html | json