Jump to

• Request
• Response
• Examples

Execute SDO_GEOR_UTL Package Functions

post

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

Execute MDSYS.SDO_GEOR_UTL 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_UTL package

  Allowed Values: [ "calcrasternominalsize", "calcrasterstoragesize", "calcsurfacearea", "createdmltrigger", "emptyblocks", "fillemptyblocks", "generatecolorramp", "generategrayramp", "renamerdt" ]

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Match One Schema

Show Source

• object calcrasternominalsize_param
• object calcrasterstoragesize_param
• object calcsurfacearea_param
• object createdmltrigger_param
• object emptyblocks_param
• object fillemptyblocks_param
• object generatecolorramp_param
• object generategrayramp_param
• object renamerdt_param

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/calcrasternominalsize_param"
        },
        {
            "$ref":"#/components/schemas/calcrasterstoragesize_param"
        },
        {
            "$ref":"#/components/schemas/calcsurfacearea_param"
        },
        {
            "$ref":"#/components/schemas/createdmltrigger_param"
        },
        {
            "$ref":"#/components/schemas/emptyblocks_param"
        },
        {
            "$ref":"#/components/schemas/fillemptyblocks_param"
        },
        {
            "$ref":"#/components/schemas/generatecolorramp_param"
        },
        {
            "$ref":"#/components/schemas/generategrayramp_param"
        },
        {
            "$ref":"#/components/schemas/renamerdt_param"
        }
    ]
}

Nested Schema : calcrasternominalsize_param

Type: object

Show Source

• bitmapmask: string
• geor(required): object sdo_georaster
• padding: string
• pyramid: string

{
    "type":"object",
    "properties":{
        "geor":{
            "$ref":"#/components/schemas/sdo_georaster"
        },
        "padding":{
            "type":"string"
        },
        "pyramid":{
            "type":"string"
        },
        "bitmapmask":{
            "type":"string"
        }
    },
    "required":[
        "geor"
    ]
}

Nested Schema : calcrasterstoragesize_param

Type: object

Show Source

• geor(required): object sdo_georaster

{
    "type":"object",
    "properties":{
        "geor":{
            "$ref":"#/components/schemas/sdo_georaster"
        }
    },
    "required":[
        "geor"
    ]
}

Nested Schema : calcsurfacearea_param

Type: object

Show Source

• georaster(required): object sdo_georaster
• parallel(required): number
• window(required): object sdo_geometry

{
    "type":"object",
    "properties":{
        "georaster":{
            "$ref":"#/components/schemas/sdo_georaster"
        },
        "window":{
            "$ref":"#/components/schemas/sdo_geometry"
        },
        "parallel":{
            "type":"number"
        }
    },
    "required":[
        "georaster",
        "window",
        "parallel"
    ]
}

Nested Schema : createdmltrigger_param

Type: object

Show Source

• columnname(required): string
• tablename(required): string

{
    "type":"object",
    "properties":{
        "tablename":{
            "type":"string"
        },
        "columnname":{
            "type":"string"
        }
    },
    "required":[
        "tablename",
        "columnname"
    ]
}

Nested Schema : emptyblocks_param

Type: object

Show Source

• bgvalues: array sdo_number_array
• geor(required): object sdo_georaster
• parallelparam: string

{
    "type":"object",
    "properties":{
        "geor":{
            "$ref":"#/components/schemas/sdo_georaster"
        },
        "bgvalues":{
            "$ref":"#/components/schemas/sdo_number_array"
        },
        "parallelparam":{
            "type":"string"
        }
    },
    "required":[
        "geor"
    ]
}

Nested Schema : fillemptyblocks_param

Type: object

Show Source

• bgvalues: array sdo_number_array
• geor(required): object sdo_georaster

{
    "type":"object",
    "properties":{
        "geor":{
            "$ref":"#/components/schemas/sdo_georaster"
        },
        "bgvalues":{
            "$ref":"#/components/schemas/sdo_number_array"
        }
    },
    "required":[
        "geor"
    ]
}

Nested Schema : generatecolorramp_param

Type: object

Show Source

• cellvaluetype(required): string
• colorseeds(required): object sdo_geor_colormap
• interpoparam: string
• rampsteps(required): array sdo_number_array

{
    "type":"object",
    "properties":{
        "colorseeds":{
            "$ref":"#/components/schemas/sdo_geor_colormap"
        },
        "rampsteps":{
            "$ref":"#/components/schemas/sdo_number_array"
        },
        "cellvaluetype":{
            "type":"string"
        },
        "interpoparam":{
            "type":"string"
        }
    },
    "required":[
        "colorseeds",
        "rampsteps",
        "cellvaluetype"
    ]
}

Nested Schema : generategrayramp_param

Type: object

Show Source

• cellvaluetype(required): string
• grayseeds(required): object sdo_geor_grayscale
• interpoparam: string
• rampsteps(required): array sdo_number_array

{
    "type":"object",
    "properties":{
        "grayseeds":{
            "$ref":"#/components/schemas/sdo_geor_grayscale"
        },
        "rampsteps":{
            "$ref":"#/components/schemas/sdo_number_array"
        },
        "cellvaluetype":{
            "type":"string"
        },
        "interpoparam":{
            "type":"string"
        }
    },
    "required":[
        "grayseeds",
        "rampsteps",
        "cellvaluetype"
    ]
}

Nested Schema : renamerdt_param

Type: object

Show Source

• newrdts: string
• oldrdts(required): string

{
    "type":"object",
    "properties":{
        "oldrdts":{
            "type":"string"
        },
        "newrdts":{
            "type":"string"
        }
    },
    "required":[
        "oldrdts"
    ]
}

Nested Schema : sdo_georaster

Type: object

Show Source

• rasterDataTable: string
• rasterID: integer

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

Nested Schema : sdo_geometry

Type: object

Show Source

• attr: string

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

Nested Schema : sdo_number_array

Type: array

Show Source

• Array of: number

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

Nested Schema : sdo_geor_colormap

Type: object

Show Source

• alpha: array sdo_number_array
• blue: array sdo_number_array
• cellvalue: array sdo_number_array
• green: array sdo_number_array
• red: array sdo_number_array

{
    "type":"object",
    "properties":{
        "cellvalue":{
            "$ref":"#/components/schemas/sdo_number_array"
        },
        "red":{
            "$ref":"#/components/schemas/sdo_number_array"
        },
        "green":{
            "$ref":"#/components/schemas/sdo_number_array"
        },
        "blue":{
            "$ref":"#/components/schemas/sdo_number_array"
        },
        "alpha":{
            "$ref":"#/components/schemas/sdo_number_array"
        }
    }
}

Nested Schema : sdo_geor_grayscale

Type: object

Show Source

• cellvalue: array sdo_number_array
• gray: array sdo_number_array

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

Back to Top

Response

200 Response

Result of the function

Body ()

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:

Back to Top

Examples

The following is an example on how to calculate optimized block size by submitting a POST request using cURL.

curl -X POST -d '{"dimensionsize":[1000,1000,3],"blocksize":[256,256,3]}' "https://localhost:8080/oraclespatial/georaster/v1/datasource1/sdo_geor_utl/calcOptimizedBlockSize" -H "Cookie: JSESSIONID=<jsessionid_value>"

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

{
   "ReturnStatus" : "Success",
   "BLOCKSIZE" : [ 250, 250, 3 ]
} 

Back to Top