Jump to

• Request
• Response
• Examples

Get the Definition of a Virtual Mosaic

get

{server}/georaster/v1/{datasource}/vm/{virtualMosaicName}

Get the definition of a virtual mosaic by specifying the virtual mosaic name.

Request

Path Parameters

• virtualMosaicName(required): string
  The name of the virtual mosaic

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Return the information of the requested virtual mosaic

Body ()

Root Schema : VMObjectResponse

Type: object

Show Source

• dimensionSize: array sdo_number_array
• links: array links
  link to self, rasterImage, rasterData
• maxNumberOfBands: integer
• name: string
• pyramidMaxLevel: integer
• spatialExtent: object sdo_geometry
• vmDefinition: object schema
  virtual mosaic related parameters. pyramidlevel, bandNumber, cropArea not included here as it will be specified at the request.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "vmDefinition":{
            "$ref":"#/components/schemas/VMObject"
        },
        "pyramidMaxLevel":{
            "type":"integer"
        },
        "maxNumberOfBands":{
            "type":"integer"
        },
        "dimensionSize":{
            "$ref":"#/components/schemas/sdo_number_array"
        },
        "spatialExtent":{
            "$ref":"#/components/schemas/sdo_geometry",
            "nullable":true
        },
        "links":{
            "type":"array",
            "description":"link to self, rasterImage, rasterData",
            "items":{
                "$ref":"#/components/schemas/instanceLink"
            }
        }
    }
}

Nested Schema : sdo_number_array

Type: array

Show Source

• Array of: number

{
    "type":"array",
    "items":{
        "type":"number"
    }
}

Nested Schema : links

Type: array

link to self, rasterImage, rasterData

Show Source

• Array of: string

{
    "type":"array",
    "description":"link to self, rasterImage, rasterData",
    "items":{
        "$ref":"#/components/schemas/instanceLink"
    }
}

Nested Schema : sdo_geometry

Type: object

Show Source

• attr: string

{
    "type":"object",
    "properties":{
        "attr":{
            "type":"string"
        }
    }
}

Nested Schema : schema

Type: object

virtual mosaic related parameters. pyramidlevel, bandNumber, cropArea not included here as it will be specified at the request.

Show Source

• bgValues: array sdo_number_array
• colorBalance: object colorBalance
• commonPointRule: string
  Allowed Values: [ "start", "end", "latest", "oldest", "ctc", "high", "low", "average", "highres" ]
• elevationParam: string
• fillGap: boolean
  Default Value: false
• nodata: boolean
  Default Value: false
• outModelCoordLoc: string
  Default Value: center

  Allowed Values: [ "center", "upperleft" ]
• outResolutions: object outResolutions
• outSRID: integer
• referencePoint: object sdo_geometry
• resamplingMethod: string
• resamplingTolerance: number
  Minimum Value: 0

  Maximum Value: 0.5
• sourceImages(required): object sourceImages

{
    "type":"object",
    "description":"virtual mosaic related parameters. pyramidlevel, bandNumber, cropArea not included here as it will be specified at the request.",
    "required":[
        "sourceImages"
    ],
    "properties":{
        "sourceImages":{
            "type":"object",
            "required":[
                "tableNames",
                "columnNames"
            ],
            "properties":{
                "tableNames":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "columnNames":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "conditions":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        },
        "outSRID":{
            "type":"integer"
        },
        "elevationParam":{
            "type":"string"
        },
        "outModelCoordLoc":{
            "type":"string",
            "enum":[
                "center",
                "upperleft"
            ],
            "default":"center"
        },
        "outResolutions":{
            "type":"object",
            "required":[
                "value"
            ],
            "properties":{
                "value":{
                    "$ref":"#/components/schemas/sdo_number_array"
                },
                "unit":{
                    "type":"string"
                }
            }
        },
        "referencePoint":{
            "$ref":"#/components/schemas/sdo_geometry"
        },
        "resamplingMethod":{
            "type":"string"
        },
        "resamplingTolerance":{
            "type":"number",
            "minimum":0,
            "maximum":0.5
        },
        "commonPointRule":{
            "type":"string",
            "enum":[
                "start",
                "end",
                "latest",
                "oldest",
                "ctc",
                "high",
                "low",
                "average",
                "highres"
            ]
        },
        "nodata":{
            "type":"boolean",
            "default":false
        },
        "fillGap":{
            "type":"boolean",
            "default":false
        },
        "colorBalance":{
            "type":"object",
            "required":[
                "balanceMethod"
            ],
            "properties":{
                "balanceMethod":{
                    "type":"string",
                    "enum":[
                        "none",
                        "linearstretching",
                        "statisticdmatching",
                        "histogrammatching"
                    ],
                    "default":"none"
                },
                "referenceMethod":{
                    "type":"string",
                    "enum":[
                        "value",
                        "image",
                        "overlap"
                    ]
                },
                "reference":{
                    "oneOf":[
                        {
                            "$ref":"#/components/schemas/sdo_georaster"
                        },
                        {
                            "type":"object",
                            "properties":{
                                "values1":{
                                    "$ref":"#/components/schemas/sdo_number_array"
                                },
                                "values2":{
                                    "$ref":"#/components/schemas/sdo_number_array"
                                }
                            }
                        },
                        {
                            "$ref":"#/components/schemas/sdo_geor_histogram"
                        }
                    ]
                }
            }
        },
        "bgValues":{
            "$ref":"#/components/schemas/sdo_number_array"
        }
    }
}

Nested Schema : colorBalance

Type: object

Show Source

• balanceMethod(required): string
  Default Value: none

  Allowed Values: [ "none", "linearstretching", "statisticdmatching", "histogrammatching" ]
• reference: reference
• referenceMethod: string
  Allowed Values: [ "value", "image", "overlap" ]

{
    "type":"object",
    "required":[
        "balanceMethod"
    ],
    "properties":{
        "balanceMethod":{
            "type":"string",
            "enum":[
                "none",
                "linearstretching",
                "statisticdmatching",
                "histogrammatching"
            ],
            "default":"none"
        },
        "referenceMethod":{
            "type":"string",
            "enum":[
                "value",
                "image",
                "overlap"
            ]
        },
        "reference":{
            "oneOf":[
                {
                    "$ref":"#/components/schemas/sdo_georaster"
                },
                {
                    "type":"object",
                    "properties":{
                        "values1":{
                            "$ref":"#/components/schemas/sdo_number_array"
                        },
                        "values2":{
                            "$ref":"#/components/schemas/sdo_number_array"
                        }
                    }
                },
                {
                    "$ref":"#/components/schemas/sdo_geor_histogram"
                }
            ]
        }
    }
}

Nested Schema : outResolutions

Type: object

Show Source

• unit: string
• value(required): array sdo_number_array

{
    "type":"object",
    "required":[
        "value"
    ],
    "properties":{
        "value":{
            "$ref":"#/components/schemas/sdo_number_array"
        },
        "unit":{
            "type":"string"
        }
    }
}

Nested Schema : sourceImages

Type: object

Show Source

• columnNames(required): array columnNames
• conditions: array conditions
• tableNames(required): array tableNames

{
    "type":"object",
    "required":[
        "tableNames",
        "columnNames"
    ],
    "properties":{
        "tableNames":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "columnNames":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "conditions":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : reference

Match One Schema

Show Source

• object sdo_georaster
• object type
• object sdo_geor_histogram

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/sdo_georaster"
        },
        {
            "type":"object",
            "properties":{
                "values1":{
                    "$ref":"#/components/schemas/sdo_number_array"
                },
                "values2":{
                    "$ref":"#/components/schemas/sdo_number_array"
                }
            }
        },
        {
            "$ref":"#/components/schemas/sdo_geor_histogram"
        }
    ]
}

Nested Schema : sdo_georaster

Type: object

Show Source

• rasterDataTable: string
• rasterID: integer

{
    "type":"object",
    "properties":{
        "rasterDataTable":{
            "type":"string"
        },
        "rasterID":{
            "type":"integer"
        }
    }
}

Nested Schema : type

Type: object

Show Source

• values1: array sdo_number_array
• values2: array sdo_number_array

{
    "type":"object",
    "properties":{
        "values1":{
            "$ref":"#/components/schemas/sdo_number_array"
        },
        "values2":{
            "$ref":"#/components/schemas/sdo_number_array"
        }
    }
}

Nested Schema : sdo_geor_histogram

Type: object

Show Source

• cellvalue: array sdo_number_array
• count: array sdo_number_array

{
    "type":"object",
    "properties":{
        "cellvalue":{
            "$ref":"#/components/schemas/sdo_number_array"
        },
        "count":{
            "$ref":"#/components/schemas/sdo_number_array"
        }
    }
}

Nested Schema : columnNames

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : conditions

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : tableNames

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

401 Response

Authentication information is missing or invalid

Headers

• WWW_Authenticate:

Back to Top

Examples

The following is an example on how to request the definition of a mosaic with name "landsatMosaic" by submitting a GET request using cURL.

curl -X GET "https://localhost:8080/oraclespatial/georaster/v1/datasource1/vm/landsatMosaic" -H "Cookie: JSESSIONID=<jsessionid_value>"

The following shows an example of the response JSON format for the above request.

{
     "name" : "landsatMosaic",
     "vmDefinition" : {
       "sourceImages" : {
         "tableNames" : [ "landsat" ],
         "columnNames" : [ "image" ],
         "conditions" : null
       },
       "outSRID" : 4326,
       "outResolutions" : [ 30.0, 30.0 ],
       "resolutionUnit" : "meter",
       "resamplingMethod" : "bilinear",
       "resamplingTolerance" : 0.2,
       "commonPointRule" : "high"
     },
     "pyramidMaxLevel" : 7,
     "maxNumberOfBand" : 3,
     "cellDepth" : "8BIT_U",
     "dimensionSize" : [ 111498, 186723 ],
     "spatialExtent" : {
       "srid" : 4326,
       "polygon" : {
         "boundary" : [ {
           "rectangle" : {
             "datapoints" : [ [ -130.10368, 22.6478 ], [ -64.168344, 52.7826807 ] ]
           }
         } ]
       }
     },
     "links" : [ {
       "rel" : "self",
       "href" : "http://localhost:8080/oraclespatial/georaster/v1/datasource1/vm/landsatMosaic"
     }, {
       "rel" : "rasterImage",
       "href" : "http://localhost:8080/oraclespatial/georaster/v1/datasource1/vm/landsatMosaic/rasterImage"
     }, {
       "rel" : "rasterData",
       "href" : "http://localhost:8080/oraclespatial/georaster/v1/datasource1/vm/landsatMosaic/rasterData"
     }, {
       "rel" : "statistics",
       "href" : "http://localhost:8080/oraclespatial/georaster/v1/datasource1/vm/landsatMosaic/statistics"
     }, {
       "rel" : "parent",
       "href" : "http://localhost:8080/oraclespatial/georaster/v1/datasource1/vm"
     } ]
 } 

Back to Top