Get a GeoRaster Object
get
{server}/georaster/v1/{datasource}/{tableName}/{georasterColumnName}/{rdt}/{rid}
Get a GeoRaster Object in JSON format with the given RDT and RID.
Request
Path Parameters
-
georasterColumnName(required): string
The name of the GeoRaster ColumnExamples
-
rdt(required): string
The Raster Data Table (RDT) Name.Examples
-
rid(required): integer
The Raster ID (RID) of the GeoRaster Object.Examples
-
tableName(required): string
The name of the table, could be prefixed with a schema nameExamples
Query Parameters
-
includeMetadata: boolean
Boolean parameter to indicate whether to include the metadata in the returned object stream. If not specfied, metadata is not returned.Default Value:
false
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Return the GeoRaster Object.
Root Schema : georasterObjectResponse
Type:
object
The json response of the information of the GeoRaster Object
Show Source
-
links(required): array
links
links to self, canonical, metadata, rasterdata of the GeoRaster Object
-
metadata: object
sdogeormetadata
GeoRaster Object metadata
-
rasterDataTable(required): string
-
rasterID(required): integer
(int64)
-
rasterType(required): string
Pattern:
2[0|1]001
-
spatialExent:
spatialExent
Nested Schema : links
Type:
array
links to self, canonical, metadata, rasterdata of the GeoRaster Object
Show Source
Nested Schema : sdogeormetadata
Type:
object
GeoRaster Object metadata
Show Source
-
bandReferenceInfo: object
rasterBandReferenceSystemType
-
layerInfo(required): array
layerInfo
-
objectInfo(required): object
objectDescriptionType
-
rasterInfo(required): object
rasterDescriptionType
-
sourceInfo: string
-
spatialReferenceInfo: object
rasterSpatialReferenceSystemType
-
temporalReferenceInfo: object
rasterTemporalReferenceSystemType
Nested Schema : rasterBandReferenceSystemType
Type:
Show Source
object
-
bandReference: array
bandReference
-
description: string
-
isReferenced(required): boolean
Default Value:
false
-
minSpectralResolution: object
spatialResolution
-
radiometricResolutionDescription: string
-
spectralExtent(required): object
extentType
-
spectralResolutionDescription: string
-
spectralTolerance: number
-
spectralUnit(required):
Default Value:
MICROMETER
Allowed Values:[ "METER", "MILLIMETER", "MICROMETER", "NANOMETER" ]
Nested Schema : objectDescriptionType
Type:
Show Source
object
-
blankCellValue: number
-
defaultAlpha: integer
Minimum Value:
1
Minimum Value:> false
-
defaultBlue: integer
Minimum Value:
1
Minimum Value:> false
-
defaultGreen: integer
Minimum Value:
1
Minimum Value:> false
-
defaultPyramidLevel: integer
-
defaultRed: integer
Minimum Value:
1
Minimum Value:> false
-
description: string
-
ID: string
-
isBlank(required): boolean
Default Value:
false
-
majorVersion: string
-
minorVersion: string
-
rasterType(required): integer
Nested Schema : rasterDescriptionType
Type:
Show Source
object
-
blocking(required): object
blockingDescriptionType
-
cellDepth(required):
Default Value:
8BIT_U
Allowed Values:[ "1BIT", "2BIT", "4BIT", "8BIT_U", "8BIT_S", "16BIT_U", "16BIT_S", "32BIT_U", "32BIT_S", "32BIT_REAL", "64BIT_REAL", "64BIT_COMPLEX", "128BIT_COMPLEX" ]
-
cellRepresentation(required):
Default Value:
UNDEFINED
Allowed Values:[ "POINT", "SEGMENT", "TRIANGLE", "SQUARE", "RECTANGLE", "CUBE", "TETRAHEDRON", "HEXAHEDRON", "UNDEFINED" ]
-
compression(required):
Allowed Values:
[ "NONE", "JPEG-F", "DEFLATE", "LT-MG2", "LT-MG3", "LT-JP2" ]
-
dimensionSize(required): object
cellDimensionSizeType
-
interleaving(required):
Default Value:
BSQ
Allowed Values:[ "BSQ", "BIP", "BIL" ]
-
NODATA: number
-
pyramid(required): object
pyramidDescriptionType
-
totalDimensions(required): integer
Minimum Value:
2
Minimum Value:> false
Maximum Value:3
Maximum Value:< false
Default Value:2
-
ULTCoordinate(required): object
cellCoordinateType
Nested Schema : rasterSpatialReferenceSystemType
Type:
Show Source
object
-
description: string
-
gcpGeoreferenceModel: object
GCPGeoreferenceType
-
gcpTableName: string
-
isOrthoRectified: boolean
-
isRectified: boolean
-
isReferenced(required): boolean
Default Value:
false
-
modelCoordinateLocation:
Allowed Values:
[ "CENTER", "UPPERLEFT" ]
-
modelDimensionDescription: string
-
modelType:
Allowed Values:
[ "RigorousModel", "StoredFunction", "FunctionalFitting" ]
-
polynomialModel: object
rationalPolynomialType
-
spatialResolution: object
spatialResolution
-
spatialTolerance: number
-
SRID(required): integer
Minimum Value:
0
Minimum Value:> false
-
verticalSRID: integer
Nested Schema : spatialResolution
Type:
Show Source
object
-
sResolution: number
Default Value:
1
-
tResolution: number
Default Value:
1
-
xResolution: number
Default Value:
1
-
yResolution: number
Default Value:
1
-
zResolution: number
Default Value:
1
Nested Schema : segmentationDataType
Type:
Show Source
object
-
extent(required): object
extentType
-
firstSegNumber(required): integer
Default Value:
1
-
totalSegNumber(required): integer
Minimum Value:
1
Minimum Value:> false
Nested Schema : layerDescriptionType
Type:
Show Source
object
-
layerDimension(required):
Default Value:
BAND
Allowed Values:[ "ROW", "COLUMN", "VERTICAL", "BAND", "TEMPORAL" ]
-
objectLayer: object
layerType
-
subLayer: array
subLayer
Nested Schema : layerType
Type:
Show Source
object
-
binFunction: object
binFunctionType
-
bitmapMask: boolean
Default Value:
false
-
colorMap: object
colorMapType
-
description: string
-
grayScale: object
grayScaleType
-
layerDimensionOrdinate(required): integer
-
layerID(required): string
-
layerNumber(required): integer
Minimum Value:
0
Minimum Value:> false
-
NODATA: object
NODATAType
-
scalingFunction: object
scalingFunctionType
-
statisticDataset: object
statisticDatasetType
-
vatTableName: string
Nested Schema : binFunctionType
Type:
Show Source
object
-
binDefinition(required):
binDefinition
-
binType(required):
Allowed Values:
[ "LINEAR", "LOGARITHM", "EXPLICIT" ]
Nested Schema : scalingFunctionType
Type:
Show Source
object
-
a0(required): number
Default Value:
1
-
a1(required): number
Default Value:
0
-
b0(required): number
Default Value:
1
-
b1(required): number
Default Value:
0
Nested Schema : rectangularWindowType
Type:
Show Source
object
-
columnWidth(required): integer
Minimum Value:
1
Minimum Value:> false
-
origin(required): object
cellCoordinateType
-
rowHeight(required): integer
Minimum Value:
1
Minimum Value:> false
Nested Schema : cellCountType
Type:
Show Source
object
-
count(required): integer
Minimum Value:
0
Minimum Value:> false
-
value(required): number
Nested Schema : blockingDescriptionType
Type:
Show Source
object
-
bandBlockSize: integer
Minimum Value:
1
Minimum Value:> false
-
blockingType(required):
Default Value:
NONE
Allowed Values:[ "NONE", "REGULAR" ]
-
columnBlockSize(required): integer
Minimum Value:
1
Minimum Value:> false
-
rowBlockSize(required): integer
Minimum Value:
1
Minimum Value:> false
-
totalBandBlocks: integer
Minimum Value:
1
Minimum Value:> false
-
totalColumnBlocks(required): integer
Minimum Value:
1
Minimum Value:> false
-
totalRowBlocks(required): integer
Minimum Value:
1
Minimum Value:> false
Nested Schema : cellDimensionSizeType
Type:
Show Source
object
-
bandDimensionSize: integer
Minimum Value:
1
Minimum Value:> false
-
columnDimensionSize(required): integer
Minimum Value:
1
Minimum Value:> false
-
rowDimensionSize(required): integer
Minimum Value:
1
Minimum Value:> false
-
temporalDimensionSize: integer
Minimum Value:
1
Minimum Value:> false
-
verticalDimensionSize: integer
Minimum Value:
1
Minimum Value:> false
Nested Schema : pyramidDescriptionType
Type:
Show Source
object
-
maxLevel:
maxLevel
-
pyramidType(required):
Default Value:
NONE
Allowed Values:[ "NONE", "DECREASE", "INCREASE", "BIDIRECTION" ]
-
resampling:
Default Value:
NN
Allowed Values:[ "NN", "BILINEAR", "CUBIC", "AVERAGE4", "AVERAGE16", "BIQUADRATIC", "OTHER" ]
Nested Schema : maxLevel
Default Value:
0
Match All
Show Source
-
integer
Minimum Value:
0
Minimum Value:> false
Nested Schema : GCPGeoreferenceType
Type:
Show Source
object
-
FFMethod:
Allowed Values:
[ "Affine", "QuadraticPolynomial", "CubicPolynomial", "DLT", "QuadraticRational", "RPC" ]
-
gcp(required): array
gcp
Nested Schema : rationalPolynomialType
Type:
Show Source
object
-
columnOff(required): number
-
columnRMS: number
-
columnScale(required): number
-
modelTotalRMS: number
-
pPolynomial(required): object
polynomialType
-
qPolynomial(required): object
polynomialType
-
rowOff(required): number
-
rowRMS: number
-
rowScale(required): number
-
rPolynomial(required): object
polynomialType
-
sPolynomial(required): object
polynomialType
-
totalRMS: number
-
xOff(required): number
-
xRMS: number
-
xScale(required): number
-
yOff(required): number
-
yRMS: number
-
yScale(required): number
-
zOff(required): number
-
zRMS: number
-
zScale(required): number
Nested Schema : GCPType
Type:
Show Source
object
-
cellDimension(required): integer
Minimum Value:
0
Minimum Value:> false
-
column(required): number
Default Value:
0
-
description: string
-
gcpPointType(required):
Allowed Values:
[ "ControlPoint", "CheckPoint" ]
-
ID: string
-
modelDimension(required): integer
Minimum Value:
0
Minimum Value:> false
-
row(required): number
Default Value:
0
-
status:
Allowed Values:
[ "Measured", "Removed", "Estimated", "Validated", "Invalid" ]
-
vertical: integer
-
X(required): number
Default Value:
0
-
xRMS: number
-
Y(required): number
Default Value:
0
-
yRMS: number
-
Z: number
-
zRMS: number
Nested Schema : polynomialType
Type:
Show Source
object
-
nCoefficients(required): integer
Minimum Value:
0
Minimum Value:> false
-
nVars(required): integer
Minimum Value:
0
Minimum Value:> false
-
order(required): integer
Minimum Value:
0
Minimum Value:> false
-
polynomialCoefficients(required): array
polynomialCoefficients
-
pType: integer
Minimum Value:
0
Minimum Value:> false
Examples
401 Response
Examples
The following is an example on how to get a single GeoRaster Object by submitting a GET request using cURL.
curl -X GET "https://localhost:8080/oraclespatial/georaster/v1/datasource1/image_table/image/image_table_RDT1/1" -H "Cookie: JSESSIONID=<jsessionid_value>"
The following shows an example of the response body in JSON format for the above request.
{ "rasterType": 21001, "spatialExtent": null, "rasterDataTable": "image_table_RDT1", "rasterID": 1, "links": [{ "rel" : "self" , "href" : "https://localhost:8080/oraclespatial/georaster/v1/datasource1/image_table/image/image_table_RDT1/1" }, { "rel" : "metadata", "href" : "https://localhost:8080/oraclespatial/georaster/v1/datasource1/image_table/image/image_table_RDT1/1/metadata" }] }