Build Multidimensional Transpose—REST APIs | Documentation for ArcGIS Enterprise

URL:https://<rasteranalysistools-url>/BuildMultidimensionalTranspose
Version Introduced:10.8

Description

Build Multidimensional Transpose diagram

The BuildMultidimensionalTranspose task transposes a multidimensional raster dataset, which divides the multidimensional data along each dimension to optimize performance when accessing pixel values across all slices.

License:

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

The input multidimensional raster must be in Cloud Raster Format (CRF). Currently, no other formats are supported. To convert a mosaic dataset or NetCDF file to a multidimensional CRF, use the Create Imagery Layer tool, export to CRF, and select Process as Multidimensional.

Request parameters


Parameter	Details
inputMultidimensionalRaster (Required)	The portal folder ID, portal item ID, image service URL, cloud multidimensional raster dataset, or shared multidimensional raster dataset. At least one type of input must be provided in the JSON object. If multiple inputs are given, the itemId takes priority. 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>data path>}`
deleteTranspose	Specifies whether to delete an existing transpose. If set to true, the existing transpose will be deleted and no new transpose will be built. If set to false, a new transpose will be build. If there is an existing transpose, it will be overwritten. The default is false. Values: true \| false
context	Contains additional settings that affect task execution. This task has the following setting: Parallel Processing Factor (parallelProcessingFactor)—The specified number or percentage of processes will be used for the analysis.
f	The response format. The default response format is html. Values: html \| json

Example usage

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

https://machine.domain.com/webadaptor/rest/services/System/RasterAnalysisTools/GPServer/BuildMultidimensionalTranspose?inputMultidimensionalRaster={"itemId": "1780d648db3545bba8661ad98df824a4"}&deleteTranspose=false&context=&f=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://<rasterAnalysisTools-url>/BuildMultidimensionalTranspose/jobs/<jobId>

Accessing results

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:

https://<rasterAnalysisTools-url>/BuildMultidimensionalTranspose/jobs/<jobId>/results/result

Parameter Details

Parameter	Details
outputMultidimensionalRaster	The image service URL. Example `{"url": "https://<raster analysis url>/BuildMultidimensionalTranspose /jobs/<jobId>/results/outputMultidimensionalRaster"}` The result has properties for parameter name, data type, and value. The content of the value is always the image service URL. `{ "paramName": "outputRaster", "dataType": "GPString", "value": { "url": " https://<server name>/arcgis/rest/services/Hosted/<service name>/ImageServer " } }`

outputMultidimensionalRaster

The image service URL.

Example

{"url": "https://<raster analysis url>/BuildMultidimensionalTranspose /jobs/<jobId>/results/outputMultidimensionalRaster"}

The result has properties for parameter name, data type, and value. The content of the value is always the image service URL.

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

JSON Response example

The response returns the results output parameter, which has properties for parameter name, data type, and value. The content of value is always the image service URL.

{
  "paramName": "result",
  "dataType": "GPString",
  "value": {
		  "url": "https://machine.domain.com/webadaptor/rest/services/Hosted/<service name>/ImageServer"
  }
}