Manage Multidimensional Raster

targetMultidimensionalRaster

(Required)

The Portal Item ID, Image Service URL, cloud multidimensional raster dataset or shared multidimensional raster dataset.

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

Example:

1
2
3
{"itemId": <portal item id>}
{“url”: <image service url>}
{“uri”: <cloud raster uri or shared data path>}

manageMode

Specifies the type of modification that will be performed on the target raster:

• ADD_DIMENSION—Add a new dimension to the multidimensional raster information.
• APPEND_SLICES—Add slices from another multidimensional raster. Slices are added to the end of the slices for a dimension. This is the default.
• APPEND_VARIABLES—Add one or more variable from another multidimensional raster.
• REPLACE_SLICES—Replace existing slices from another multidimensional raster, at specific dimension values.
• DELETE_VARIABLES—Delete one or more variables from the multidimensional raster.
• REMOVE_DIMENSION—Convert a single slice multidimensional raster into a dimensionless raster.
• TRUNCATE_DIMENSION_VALUES—Modify the dimension values by truncating date values, or by selecting the start and end values when the dimension values are ranges.
• REMOVE_SLICES —Remove a slice, or a range of slices from the multidimensional raster.

Syntax: A string representing the manage mode.

Example:

1
manageMode=”REMOVE_DIMENSION”

variables

The variable or variables that will be modified in the target multidimensional raster. This is required if the operation being performed is a modification of an existing variable.

If no variable is specified, the first variable in the target multidimensional raster will be modified

Syntax: A list of variables. Multiple variables are separated by comma.

Example:

1
variables=[“salinity”,”water_temp”]

inputMultidimensionalRasters

List of input rasters. The input raster can be the Portal Item ID, Image Service URL, cloud raster dataset or shared multidimensional raster dataset.

This is required when manageMode is set to APPEND_SLICES, REPLACE_SLICES, or APPEND_VARIABLES.

At least one type of input needs to be provided in the JSON object. If multiple inputs are given. The itemid takes the priority.

Syntax: A JSON object describing the input rasters.

Example:

1
2
3
{"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>]}

dimensionName

The name of the dimension to be added to the dataset. This is required if manageMode is set to ADD_DIMENSION.

Syntax: A string containing the name of the dimension.

Example:

1
dimensionName="StdZ"

dimensionValue

The value of the dimension to be added. This is required if manageMode is set to ADD_DIMENSION.

Syntax: A string representing the value of the dimension name.

Example:

1
dimensionValue=”5”

dimensionDescription

The description of the dimension to be added. This is required if manageMode is set to ADD_DIMENSION.

Syntax: A string describing the dimension.

Example:

1
dimensionDescription=”Depth at 5m increments”

dimensionUnit

The unit of the dimension to be modified.

Example:

1
dimensionUnit=”meter”

updateStatistics

(Optional)

Specifies whether the statistics will be recalculated for the multidimensional raster dataset.

• true- Statistics will be recalculated. This is the default.
• false- Statistics will not be recalculated.

updateTranspose

(Optional)

Specifies whether the transpose will be rebuilt for the multidimensional raster dataset.

• true- The transpose will be rebuilt. If no transpose exists, a new transpose will be built. This is the default.
• false- The transpose will not be recalculated.

truncationUnit

(Optional)

Specifies the date and time truncation unit that will be used. This parameter is required when the manageMode parameter is set to TRUNCATE_DIMENSION_VALUES and the dimensioName parameter is set to STDTIME. The accepted values for this parameter are listed below:

• SECOND: The specified time unit of truncation will be second.
• MINUTE: The specified time unit of truncation will be minute.
• HOUR: The specified time unit of truncation will be hour.
• DAY: The specified time unit of truncation will be day.
• MONTH: The specified time unit of truncation will be month.
• YEAR: The specified time unit of truncation will be year.

Example:

1
truncationUnit="MONTH"

startEndKeyword

(Optional)

Specifies how the dimension value will be truncated. This parameter is enabled when the manageMode parameter is set to TRUNCATE_DIMENSION_VALUES. The accepted values for this parameter are listed below:

• START: The dimension value will be truncated on the start value.
• END: The dimension value will be truncated on the end value.
• BOTH: The dimension value will be truncated on both the start and end values.

Example:

1
startEndKeyword="END"

dimensionDefinition

(Optional)

Specifies how the dimension will be sliced. When set as BY_VALUES, the dimension will be sliced using a list of dimension values. When set as BY_RANGES the dimension will be sliced using a range. The default value is BY_VALUES.

Values: BY_VALUES | BY_RANGES

Example:

1
dimensionDefinition="BY_RANGES"

minValue

(Optional)

The minimum value of the range of slices that will be removed. This parameter is enabled when the dimensionDefinition parameter is set to BY_RANGES.

Example:

1
minValue="2005-01-01T00:00:00"

maxValue

(Optional)

The maximum value of the range of slices that will be removed. This parameter is enabled when the dimensionDefinition parameter is set to BY_RANGES.

Example:

1
maxValue="2015-12-01T00:00:00"

context

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.

Example:

1
context={"cellSize": "20", "parallelProcessingFactor": "4"}

f

The response format. The default response format is html.

Values: html | json

updatedTargetMultidimensionalRaster

The output multidimensional raster itemId and URL

Example:

1
{"url": "http://<raster analysis url>/ManageMultidimensionalRaster/jobs/<jobId>/results/updatedTargetMultidimensionalRaster"}

The result 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.

1
2
3
4
5
6
7
8
{
  "paramName": "updatedTargetMultidimensionalRaster",
  "dataType": "GPString",
  "value": {
    "itemId": "c267610d0feb4370bf38cc6e2c4ac261",
    "url": "https://<server name>/arcgis/rest/services/Hosted/<service name>/ImageServer"
  }
}