Manage Multidimensional Raster

Description

Manage Multidimensional Raster

The ManageMultidimensionalRaster task edits a multidimensional raster by adding or deleting variables or dimensions.

LicenseLicense:
As of 10.5.1, you must license your ArcGIS Server as an ArcGIS Image Server to use this resource.

Request parameters

Parameter

Details

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.

{"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.

Syntax: A string representing the manage mode.

Example

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

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 manage_mode 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

{"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 manage_mode is set to ADD_DIMENSION.

Syntax: A string containing the name of the dimension.

Example

dimensionName="StdZ"

dimensionValue

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

Example

dimensionValue=”5”

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

dimensionDescription

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

Syntax: A string describing the dimension.

Example

dimensionDescription=”Depth at 5m increments”

dimensionUnit

The unit of the dimension to be modified.

Example

dimensionUnit=”meter”

context

(Optional)

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

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

f

The response format. The default response format is html.

Values: html | json

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 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:

https://<analysis-url>/ManageMultidimensionalRaster/jobs/<jobId>

Accessing results

When the status of the job request is esriJobSucceded, you can access the results of the analysis by making a request of the following form.

https://<raster analysis url>/ManageMultidimensionalRaster/jobs/<jobId>/results/updatedTargetMultidimensionalRaster?token=<your token>&f=json

Parameter

Description

updatedTargetMultidimensionalRaster

The output multidimensional raster URL

Example:

{"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 image service URL

{
 "paramName": "updatedTargetMultidimensionalRaster",
 "dataType": "GPString",
 "value": {
  "url": "https://<server name>/arcgis/rest/services/Hosted/<service name>/ImageServer"
 }
}

Copyright © 1995-2021 Esri. All rights reserved.