Jump to

• Request
• Response
• Examples

Get Virtual Mosaic Data in RAW Data Format

post

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

Get a subset of the specified virtual mosaic in multi-part data format.

Request

Path Parameters

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

Query Parameters

• format: string
  the format of the raster data, one of the following value, BASE64, RAW.

  Allowed Values: [ "BASE64", "RAW" ]

  Example:

  RAW

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

virtual mosaic retrieval parameter. Some parameters are part of the virtual mosaic definition too. If these parameters are specified, they will overwrite the parameters specified at virutal mosaic definition.

Show Source

• bandNumbers: string
• bgValues: array sdo_number_array
• colorBalance: object colorBalance
• commonPointRule: string
  Allowed Values: [ "start", "end", "latest", "oldest", "ctc", "high", "low", "average", "highres" ]
• considerNodata: boolean
  Default Value: false
• cropArea: cropArea
• fillGap: boolean
  Default Value: false
• memoryParam: object memoryParam
  the memory usage parameter
• pyramidLevel: integer
• resamplingMethod: string
• resamplingTolerance: number
  Minimum Value: 0

  Maximum Value: 0.5
• resFilter: boolean
  Default Value: false

{
    "type":"object",
    "description":"virtual mosaic retrieval parameter. Some parameters are part of the virtual mosaic definition too. If these parameters are specified, they will overwrite the parameters specified at virutal mosaic definition.",
    "properties":{
        "pyramidLevel":{
            "type":"integer"
        },
        "bandNumbers":{
            "type":"string"
        },
        "cropArea":{
            "oneOf":[
                {
                    "$ref":"#/components/schemas/sdo_number_array"
                },
                {
                    "$ref":"#/components/schemas/sdo_geometry"
                }
            ],
            "nullable":true
        },
        "resamplingMethod":{
            "type":"string"
        },
        "resamplingTolerance":{
            "type":"number",
            "minimum":0,
            "maximum":0.5
        },
        "commonPointRule":{
            "type":"string",
            "enum":[
                "start",
                "end",
                "latest",
                "oldest",
                "ctc",
                "high",
                "low",
                "average",
                "highres"
            ]
        },
        "considerNodata":{
            "type":"boolean",
            "default":false
        },
        "fillGap":{
            "type":"boolean",
            "default":false
        },
        "resFilter":{
            "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":{
                                "value1":{
                                    "$ref":"#/components/schemas/sdo_number_array"
                                },
                                "value2":{
                                    "$ref":"#/components/schemas/sdo_number_array"
                                }
                            }
                        },
                        {
                            "$ref":"#/components/schemas/sdo_geor_histogram"
                        }
                    ]
                }
            }
        },
        "bgValues":{
            "$ref":"#/components/schemas/sdo_number_array"
        },
        "memoryParam":{
            "$ref":"#/components/schemas/memoryParam"
        }
    }
}

Nested Schema : sdo_number_array

Type: array

Show Source

• Array of: number

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

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":{
                        "value1":{
                            "$ref":"#/components/schemas/sdo_number_array"
                        },
                        "value2":{
                            "$ref":"#/components/schemas/sdo_number_array"
                        }
                    }
                },
                {
                    "$ref":"#/components/schemas/sdo_geor_histogram"
                }
            ]
        }
    }
}

Nested Schema : cropArea

Match One Schema

Show Source

• array sdo_number_array
• object sdo_geometry

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/sdo_number_array"
        },
        {
            "$ref":"#/components/schemas/sdo_geometry"
        }
    ],
    "nullable":true
}

Nested Schema : memoryParam

Type: object

the memory usage parameter

Show Source

• maxMemSize: integer (int64)
• readBlockMemSize: integer
• writeBlockMemSize: integer

{
    "type":"object",
    "description":"the memory usage parameter",
    "properties":{
        "maxMemSize":{
            "type":"integer",
            "format":"int64"
        },
        "readBlockMemSize":{
            "type":"integer"
        },
        "writeBlockMemSize":{
            "type":"integer"
        }
    }
}

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":{
                "value1":{
                    "$ref":"#/components/schemas/sdo_number_array"
                },
                "value2":{
                    "$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

• value1: array sdo_number_array
• value2: array sdo_number_array

{
    "type":"object",
    "properties":{
        "value1":{
            "$ref":"#/components/schemas/sdo_number_array"
        },
        "value2":{
            "$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 : sdo_geometry

Type: object

Show Source

• attr: string

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Return the virtual mosaic subset in multi-part data format.

Body ()

Root Schema : rasterData

Type: object

The json response of the information of the GeoRaster raster data, the binary data is to be followed after this in the multi-part format.

Show Source

• area(required): object sdo_geometry
• links(required): array links
  links to self, metadata and the GeoRaster Object
• window(required): array sdo_number_array

{
    "type":"object",
    "description":"The json response of the information of the GeoRaster raster data, the binary data is to be followed after this in the multi-part format.",
    "required":[
        "window",
        "area",
        "links"
    ],
    "properties":{
        "window":{
            "$ref":"#/components/schemas/sdo_number_array"
        },
        "area":{
            "$ref":"#/components/schemas/sdo_geometry"
        },
        "links":{
            "type":"array",
            "description":"links to self, metadata and the GeoRaster Object",
            "items":{
                "$ref":"#/components/schemas/instanceLink"
            }
        }
    }
}

Nested Schema : sdo_geometry

Type: object

Show Source

• attr: string

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

Nested Schema : links

Type: array

links to self, metadata and the GeoRaster Object

Show Source

• Array of: string

{
    "type":"array",
    "description":"links to self, metadata and the GeoRaster Object",
    "items":{
        "$ref":"#/components/schemas/instanceLink"
    }
}

Nested Schema : sdo_number_array

Type: array

Show Source

• Array of: number

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

401 Response

Authentication information is missing or invalid

Headers

• WWW_Authenticate:

Back to Top

Examples

The following is an example on how to request a subset of the virtual mosaic by submitting a POST request using cURL.

curl -X POST -d @request.json "https://localhost:8080/oraclespatial/georaster/v1/datasource1/vm/landsatMosaic/rasterData" -H "Cookie: JSESSIONID=<jsessionid_value>"

The following is an example of request.json for the request body:

{
  "bandNumbers": "0",
  "cropArea": [
    0,
    0,
    100,
    100
  ],
  "resamplingMethod": "bilinear",
  "considerNodata": true,
  "fillGap": true,
  "commonPointRule": "low"
}

Back to Top