- URL:
- https://<rasteranalysistools-url>/BuildMultidimensionalTranspose
- Methods:
GET
- Version Introduced:
- 10.8
Description
The Build
task transposes a multidimensional raster dataset, which divides the multidimensional data along each dimension to optimize performance when accessing pixel values across all slices.
The input multidimensional raster must be in Cloud Raster Format (CRF
). Currently, no other formats are supported. To convert a mosaic dataset or Net
file to a multidimensional CRF
, use the Create Imagery Layer tool, export to CRF
, and select Process as Multidimensional.
Request parameters
Parameter | Details |
---|---|
(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 Syntax: A JSON object describes the input multidimensional raster.
|
| Specifies whether to delete an existing transpose. If set to Values: |
| Contains additional settings that affect task execution. This task has the following setting:
|
|
The response format. The default response format is html. Values: |
Example usage
The following is a sample request URL for the Build
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 job
to periodically check the status of the job and messages, as described in Check job status. Once the job has successfully completed, use the job
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 esri
, 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 |
---|---|
| The image service URL. Example
The result has properties for parameter name, data type, and value. The content of the value is always the image service URL.
|
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"
}
}