Build Multidimensional Info | ArcGIS REST APIs

URL:: https://<rasteranalysistools-url>/BuildMultidimensionalInfo
Methods:: GET
Version Introduced:: 12.0

Description

The BuildMultidimensionalInfo operation generates multidimensional metadata in the mosaic dataset, incorporating information about variables and dimensions from images collected at various times, depths, or heights.

This operation creates the following two text fields in the mosaic dataset:

Variable — Stores the names of the variables. For example, this field will store the string Temperature for all the images with temperature data, and Salinity for all the images containing salinity data.
Dimensions — Stores the names of the dimensions. For example, if your temperature data has a corresponding Date dimension field that represents the day it was captured, and your salinity data has a Depth dimension field representing the depth at which it was measured, the Dimensions field for those variables would be Date, Depth. The fields used to populate the Dimensions field must exist and be populated in the mosaic dataset.

Request parameters

Parameter Details

Parameter	Details
`imageCollection` (Required)	Specifies the output image collection (mosaic dataset) name or URL. The image service must exist before you perform build multidimensional info operations. Syntax: JSON object supports three keys: itemId, url and uri. They keys are case sensitive. Example: Use dark colors for code blocksCopy `1 2 3 {"itemId": "<portal item id>"} {"url": "<image service url>"} {"uri": "<cloud raster uri or shared data path>"}`
`variableField` (Required)	Specifies the field in the image collection that stores the variable names. This field is used to create and populate the `Variable` field. If the `Variable` field does not already exist, an existing field or string value must be specified for this parameter. If all rasters in the image collection represent the same variable, use the name of that variable (for example, `Temperature`). If the `Variable` field already exists, the operation will only update the multidimensional information. Syntax: A String (Variable Field name). Example: Use dark colors for code blocksCopy `1 variableField=ProductName`
`dimensionFields`	Specifies the fields in the image collection that store dimension information. These fields are used to create and populate a new `Dimensions` field. If the `Dimensions` field already exists, the operation will only update the multidimensional information. Syntax: a list of dictionary objects. Example: Use dark colors for code blocksCopy `1 2 3 4 5 6 7 8 9 10 11 12 dimensionFields=[ { "dimension":"<dimension field name>", "description":"<description of the field>", "units":"<units of the field>" }, { "dimension":"<dimension field name>", "description":"<description of the field>", "units":"<units of the field>" } ]`
`variableInfo`	Specifies additional information about the `Variable` field. Syntax: a list of dictionary objects. Example: Use dark colors for code blocksCopy `1 2 3 4 5 6 7 8 9 10 11 12 variableInfo=[ { "variable":"<variable name>", "description":"<description of the variable>", "units":"<units of the variable>" }, { "variable":"<variable name>", "description":"<description of the variable>", "units":"<units of the variable>" } ]`
`deleteMultidimensionalInfo`	Specifies whether existing multidimensional information will be deleted. If set as `true`, multidimensional information will be deleted. If set as `false`, multidimensional information will not be deleted. The default value is `false`. Values: `true` \| `false`
`f`	The response format. The default format is `html`. Values: `html` \| `json` \| `pjson`

imageCollection

(Required)

Specifies the output image collection (mosaic dataset) name or URL. The image service must exist before you perform build multidimensional info operations.

Syntax: JSON object supports three keys: itemId, url and uri. They keys are case sensitive.

Example:

Use dark colors for code blocksCopy
{"itemId": "<portal item id>"}
{"url": "<image service url>"}
{"uri": "<cloud raster uri or shared data path>"}

variableField

(Required)

Specifies the field in the image collection that stores the variable names. This field is used to create and populate the Variable field. If the Variable field does not already exist, an existing field or string value must be specified for this parameter. If all rasters in the image collection represent the same variable, use the name of that variable (for example, Temperature). If the Variable field already exists, the operation will only update the multidimensional information.

Syntax: A String (Variable Field name).

Example:

Use dark colors for code blocksCopy
variableField=ProductName

dimensionFields

Specifies the fields in the image collection that store dimension information. These fields are used to create and populate a new Dimensions field. If the Dimensions field already exists, the operation will only update the multidimensional information.

Syntax: a list of dictionary objects.

Example:

Use dark colors for code blocksCopy
dimensionFields=[
  {
    "dimension":"<dimension field name>",
    "description":"<description of the field>",
    "units":"<units of the field>"
  },
  {
    "dimension":"<dimension field name>",
    "description":"<description of the field>",
    "units":"<units of the field>"
  }
]

variableInfo

Specifies additional information about the Variable field.

Syntax: a list of dictionary objects.

Example:

Use dark colors for code blocksCopy
variableInfo=[
  {
    "variable":"<variable name>",
    "description":"<description of the variable>",
    "units":"<units of the variable>"
  },
  {
    "variable":"<variable name>",
    "description":"<description of the variable>",
    "units":"<units of the variable>"
  }
]

deleteMultidimensionalInfo

Specifies whether existing multidimensional information will be deleted. If set as true, multidimensional information will be deleted. If set as false, multidimensional information will not be deleted. The default value is false.

Values: true | false

f

The response format. The default format is html.

Values: html | json | pjson

Example usage

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

Use dark colors for code blocksCopy
https://organization.example.com/<context>/rest/services/System/RasterAnalysisTools/GPServer/BuildMultidimensionalInfo/submitJob?imageCollection={"itemId":"dc269c4abb794ab8a55a6f533eceab20"}&variableField=ProductName&dimensionFields=[{"dimension":"Acquisition_Date","description":"Date","units":"Days"},{"dimension":"Depth","description":"","units":""}]&f=pjson

JSON Response example

The response returns the outputMultidimensionalRaster output parameter, which 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.

Use dark colors for code blocksCopy
{
    "paramName": "outputMultidimensionalRaster",
    "dataType": "GPString",
    "value": [{
        "url": "https://<server url>/arcgis/rest/services/Hosted/Hosted_mosaic_image_collection/ImageServer"
    }]
}