Spatial REST API

Execute SDO_GEOR_AGGR Package Functions

post

{server}/georaster/v1/{datasource}/sdo_geor_aggr/{functionName}

Execute MDSYS.SDO_GEOR_AGGR package functions with the specified function names. The parameters to the function is specified in the request body in JSON. See Spatial GeoRaster Developer's Guide for the usage of each function and its parameters.

Request

Path Parameters

functionName(required): string

The name of the functions in SDO_GEOR_AGGR package

Allowed Values: [ "append", "getmosaicextent", "getmosaicresolutions", "mosaicsubset", "validateformosaicsubset" ]

Supported Media Types

application/json

Root Schema : schema

Match One Schema

Show Source

object append_param
object getmosaicextent_param
object getmosaicresolutions_param
mosaicsubset_param
object validateformosaicsubset_param

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/append_param"
        },
        {
            "$ref":"#/components/schemas/getmosaicextent_param"
        },
        {
            "$ref":"#/components/schemas/getmosaicresolutions_param"
        },
        {
            "$ref":"#/components/schemas/mosaicsubset_param"
        },
        {
            "$ref":"#/components/schemas/validateformosaicsubset_param"
        }
    ]
}

Nested Schema : append_param

Type: object

Show Source

appendparam(required): string
bgvalues: array sdo_number_array
sourcegeoraster(required): object sdo_georaster
sourcepyramidlevel(required): number
targetgeoraster(required): object sdo_georaster

{
    "type":"object",
    "properties":{
        "targetgeoraster":{
            "$ref":"#/components/schemas/sdo_georaster"
        },
        "sourcegeoraster":{
            "$ref":"#/components/schemas/sdo_georaster"
        },
        "sourcepyramidlevel":{
            "type":"number"
        },
        "appendparam":{
            "type":"string"
        },
        "bgvalues":{
            "$ref":"#/components/schemas/sdo_number_array"
        }
    },
    "required":[
        "targetgeoraster",
        "sourcegeoraster",
        "sourcepyramidlevel",
        "appendparam"
    ]
}

Nested Schema : getmosaicextent_param

Type: object

Show Source

georastercolumnnames(required): string
georastertablenames(required): string
outsrid: number

{
    "type":"object",
    "properties":{
        "georastertablenames":{
            "type":"string"
        },
        "georastercolumnnames":{
            "type":"string"
        },
        "outsrid":{
            "type":"number"
        }
    },
    "required":[
        "georastertablenames",
        "georastercolumnnames"
    ]
}

Nested Schema : getmosaicresolutions_param

Type: object

Show Source

georastercolumnnames(required): string
georastertablenames(required): string
resolutionunit: string

{
    "type":"object",
    "properties":{
        "georastertablenames":{
            "type":"string"
        },
        "georastercolumnnames":{
            "type":"string"
        },
        "resolutionunit":{
            "type":"string"
        }
    },
    "required":[
        "georastertablenames",
        "georastercolumnnames"
    ]
}

Nested Schema : mosaicsubset_param

Match One Schema

Show Source

object mosaicsubset_param_1
object mosaicsubset_param_2

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/mosaicsubset_param_1"
        },
        {
            "$ref":"#/components/schemas/mosaicsubset_param_2"
        }
    ]
}

Nested Schema : validateformosaicsubset_param

Type: object

Show Source

georastercolumnnames(required): string
georastertablenames(required): string
outresolutions(required): array sdo_number_array
outsrid(required): number
resolutionunit(required): string
resulttablename(required): string

{
    "type":"object",
    "properties":{
        "georastertablenames":{
            "type":"string"
        },
        "georastercolumnnames":{
            "type":"string"
        },
        "outsrid":{
            "type":"number"
        },
        "outresolutions":{
            "$ref":"#/components/schemas/sdo_number_array"
        },
        "resolutionunit":{
            "type":"string"
        },
        "resulttablename":{
            "type":"string"
        }
    },
    "required":[
        "georastertablenames",
        "georastercolumnnames",
        "outsrid",
        "outresolutions",
        "resolutionunit",
        "resulttablename"
    ]
}

Nested Schema : sdo_number_array

Type: array

Show Source

Array of: number

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

Nested Schema : sdo_georaster

Type: object

Show Source

rasterDataTable: string
rasterID: integer

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

Nested Schema : mosaicsubset_param_1

Type: object

Show Source

bgvalues: array sdo_number_array
boundaryclip: string
croparea: object sdo_geometry
georastercolumnnames(required): string
georastertablenames(required): string
layernumbers: string
mosaicparam: string
outgeoraster(required): object sdo_georaster
outmodelcoordloc: number
outresolutions: array sdo_number_array
outsrid: number
parallelparam: string
polygonclip: string
pyramidlevel: number
referencepoint: object sdo_geometry
resolutionunit: string
storageparam: string

{
    "type":"object",
    "properties":{
        "georastertablenames":{
            "type":"string"
        },
        "georastercolumnnames":{
            "type":"string"
        },
        "pyramidlevel":{
            "type":"number"
        },
        "outsrid":{
            "type":"number"
        },
        "outmodelcoordloc":{
            "type":"number"
        },
        "referencepoint":{
            "$ref":"#/components/schemas/sdo_geometry"
        },
        "croparea":{
            "$ref":"#/components/schemas/sdo_geometry"
        },
        "polygonclip":{
            "type":"string"
        },
        "boundaryclip":{
            "type":"string"
        },
        "layernumbers":{
            "type":"string"
        },
        "outresolutions":{
            "$ref":"#/components/schemas/sdo_number_array"
        },
        "resolutionunit":{
            "type":"string"
        },
        "mosaicparam":{
            "type":"string"
        },
        "storageparam":{
            "type":"string"
        },
        "outgeoraster":{
            "$ref":"#/components/schemas/sdo_georaster"
        },
        "bgvalues":{
            "$ref":"#/components/schemas/sdo_number_array"
        },
        "parallelparam":{
            "type":"string"
        }
    },
    "required":[
        "georastertablenames",
        "georastercolumnnames",
        "outgeoraster"
    ]
}

Nested Schema : mosaicsubset_param_2

Type: object

Show Source

bgvalues: array sdo_number_array
boundaryclip: string
croparea: object sdo_geometry
elevationparam: string
georastercolumnnames(required): string
georastertablenames(required): string
layernumbers: string
mosaicparam: string
outgeoraster(required): object sdo_georaster
outmodelcoordloc: number
outresolutions: array sdo_number_array
outsrid: number
parallelparam: string
polygonclip: string
pyramidlevel: number
referenceimage: object sdo_georaster
referencepoint: object sdo_geometry
referencevalue1: array sdo_number_array
referencevalue2: array sdo_number_array
refhistograms: array sdo_geor_histogram_array
resolutionunit: string
storageparam: string

{
    "type":"object",
    "properties":{
        "georastertablenames":{
            "type":"string"
        },
        "georastercolumnnames":{
            "type":"string"
        },
        "pyramidlevel":{
            "type":"number"
        },
        "elevationparam":{
            "type":"string"
        },
        "outsrid":{
            "type":"number"
        },
        "outmodelcoordloc":{
            "type":"number"
        },
        "referencepoint":{
            "$ref":"#/components/schemas/sdo_geometry"
        },
        "croparea":{
            "$ref":"#/components/schemas/sdo_geometry"
        },
        "polygonclip":{
            "type":"string"
        },
        "boundaryclip":{
            "type":"string"
        },
        "layernumbers":{
            "type":"string"
        },
        "outresolutions":{
            "$ref":"#/components/schemas/sdo_number_array"
        },
        "resolutionunit":{
            "type":"string"
        },
        "mosaicparam":{
            "type":"string"
        },
        "storageparam":{
            "type":"string"
        },
        "outgeoraster":{
            "$ref":"#/components/schemas/sdo_georaster"
        },
        "bgvalues":{
            "$ref":"#/components/schemas/sdo_number_array"
        },
        "parallelparam":{
            "type":"string"
        },
        "referenceimage":{
            "$ref":"#/components/schemas/sdo_georaster"
        },
        "referencevalue1":{
            "$ref":"#/components/schemas/sdo_number_array"
        },
        "referencevalue2":{
            "$ref":"#/components/schemas/sdo_number_array"
        },
        "refhistograms":{
            "$ref":"#/components/schemas/sdo_geor_histogram_array"
        }
    },
    "required":[
        "georastertablenames",
        "georastercolumnnames",
        "outgeoraster"
    ]
}

Nested Schema : sdo_geometry

Type: object

Show Source

attr: string

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

Nested Schema : sdo_geor_histogram_array

Type: array

Show Source

Array of: object sdo_geor_histogram

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sdo_geor_histogram"
    }
}

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"
        }
    }
}

Response

200 Response

Result of the function

Root Schema : functionReturn

Type: object

Show Source

ReturnStatus: string
ReturnValue: ReturnValue

{
    "type":"object",
    "properties":{
        "ReturnStatus":{
            "type":"string"
        },
        "ReturnValue":{
            "oneOf":[
                {
                    "type":"integer"
                },
                {
                    "type":"number"
                },
                {
                    "type":"string"
                },
                {
                    "$ref":"#/components/schemas/sdo_number_array"
                },
                {
                    "$ref":"#/components/schemas/sdo_string2_array"
                },
                {
                    "$ref":"#/components/schemas/sdo_string2_arrayset"
                },
                {
                    "$ref":"#/components/schemas/sdo_geometry"
                }
            ]
        }
    }
}

Nested Schema : ReturnValue

Match One Schema

Show Source

integer
number
string
array sdo_number_array
array sdo_string2_array
array sdo_string2_arrayset
object sdo_geometry

{
    "oneOf":[
        {
            "type":"integer"
        },
        {
            "type":"number"
        },
        {
            "type":"string"
        },
        {
            "$ref":"#/components/schemas/sdo_number_array"
        },
        {
            "$ref":"#/components/schemas/sdo_string2_array"
        },
        {
            "$ref":"#/components/schemas/sdo_string2_arrayset"
        },
        {
            "$ref":"#/components/schemas/sdo_geometry"
        }
    ]
}

Nested Schema : sdo_number_array

Type: array

Show Source

Array of: number

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

Nested Schema : sdo_string2_array

Type: array

Show Source

Array of: string

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

Nested Schema : sdo_string2_arrayset

Type: array

Show Source

Array of: array sdo_string2_array

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/sdo_string2_array"
    }
}

Nested Schema : sdo_geometry

Type: object

Show Source

attr: string

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

401 Response

Authentication information is missing or invalid

Headers

WWW_Authenticate:

Examples

The following is an example on how to append one GeoRaster Object to another GeoRaster Object by submitting a POST request using cURL.

curl -X POST -d '{"targetgeoraster":{"rasterDataTable":"image_table_RDT1","rasterID":0},"sourcegeoraster":{"rasterDataTable":"image_table_RDT1","rasterID":1},"sourcepyramidLevel":0,"appendparam":"commonPointRule=high"}' "https://localhost:8080/oraclespatial/georaster/v1/datasource1/sdo_geor_aggr/append" -H "Cookie: JSESSIONID=<jsessionid_value>"

The following shows an example of the response after the above request is successfully processed:

{
   "ReturnStatus" : "Success"
}