Jump to

• Request
• Response
• Examples

List GeoRaster Objects

get

{server}/georaster/v1/{datasource}/{tableName}/{georasterColumnName}

Query the given GeoRaster table to get a list of GeoRaster Objects.

Request

Path Parameters

• georasterColumnName(required): string
  The name of the GeoRaster Column

  Examples

  Select an example Column Name

• tableName(required): string
  The name of the table, could be prefixed with a schema name

  Examples

  Select an example Table name

Query Parameters

• limit: integer
  Limit the items included in the response, use in conjuntion with offset parameter.

  Examples

  Select an example 10 items

• offset: integer
  The amount of items from the beggining of the collection not to be included in the response.

  Examples

  Select an example Offset 0 Offset 10

• q:
  Query parameter in JSON format, see "Filtering in Queries" in ORDS documentation.
  Example: {"id":1}
  Example: {"AND":[{"state":"CA"},{"date":"10/02/2020"}]}

  Examples

  Select an example Filter by column id filter by multiple columns

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Return a list of GeoRaster Objects

Body ()

Root Schema : georasterObjectListResponse

Type: object

A list of GeoRaster Objects returned

Show Source

• count: integer
• hasMore: boolean
• items: array items
• limit: integer
• links: array links
  link to self
• offset: integer

{
    "type":"object",
    "description":"A list of GeoRaster Objects returned",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/georasterObjectResponse"
            }
        },
        "hasMore":{
            "type":"boolean"
        },
        "limit":{
            "type":"integer"
        },
        "offset":{
            "type":"integer"
        },
        "count":{
            "type":"integer"
        },
        "links":{
            "type":"array",
            "description":"link to self",
            "items":{
                "$ref":"#/components/schemas/instanceLink"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object georasterObjectResponse
  The json response of the information of the GeoRaster Object

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

Nested Schema : links

Type: array

link to self

Show Source

• Array of: string

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

Nested 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

{
    "type":"object",
    "description":"The json response of the information of the GeoRaster Object",
    "required":[
        "rasterType",
        "rasterDataTable",
        "rasterID",
        "spatialExtent",
        "links"
    ],
    "properties":{
        "rasterType":{
            "type":"string",
            "pattern":"2[0|1]001"
        },
        "rasterDataTable":{
            "type":"string"
        },
        "rasterID":{
            "type":"integer",
            "format":"int64"
        },
        "spatialExent":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/geometry"
                }
            ],
            "nullable":true
        },
        "metadata":{
            "$ref":"#/components/schemas/sdogeormetadata"
        },
        "links":{
            "type":"array",
            "description":"links to self, canonical, metadata, rasterdata of the GeoRaster Object\n",
            "items":{
                "$ref":"#/components/schemas/instanceLink"
            }
        }
    }
}

Nested Schema : links

Type: array

links to self, canonical, metadata, rasterdata of the GeoRaster Object

Show Source

• Array of: string

{
    "type":"array",
    "description":"links to self, canonical, metadata, rasterdata of the GeoRaster Object\n",
    "items":{
        "$ref":"#/components/schemas/instanceLink"
    }
}

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

{
    "type":"object",
    "description":"GeoRaster Object metadata",
    "required":[
        "objectInfo",
        "rasterInfo",
        "layerInfo"
    ],
    "properties":{
        "objectInfo":{
            "$ref":"#/components/schemas/objectDescriptionType"
        },
        "rasterInfo":{
            "$ref":"#/components/schemas/rasterDescriptionType"
        },
        "spatialReferenceInfo":{
            "$ref":"#/components/schemas/rasterSpatialReferenceSystemType"
        },
        "temporalReferenceInfo":{
            "$ref":"#/components/schemas/rasterTemporalReferenceSystemType"
        },
        "bandReferenceInfo":{
            "$ref":"#/components/schemas/rasterBandReferenceSystemType"
        },
        "layerInfo":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/layerDescriptionType"
            },
            "minLength":1
        },
        "sourceInfo":{
            "type":"string"
        }
    },
    "additionalProperties":false
}

Nested Schema : spatialExent

Match All

Show Source

• string

{
    "allOf":[
        {
            "$ref":"#/components/schemas/geometry"
        }
    ],
    "nullable":true
}

Nested Schema : rasterBandReferenceSystemType

Type: object

Show Source

• 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" ]

{
    "type":"object",
    "properties":{
        "isReferenced":{
            "type":"boolean",
            "default":false
        },
        "description":{
            "type":"string"
        },
        "radiometricResolutionDescription":{
            "type":"string"
        },
        "spectralUnit":{
            "enum":[
                "METER",
                "MILLIMETER",
                "MICROMETER",
                "NANOMETER"
            ],
            "default":"MICROMETER"
        },
        "spectralTolerance":{
            "type":"number"
        },
        "spectralResolutionDescription":{
            "type":"string"
        },
        "minSpectralResolution":{
            "$ref":"#/components/schemas/spatialResolution"
        },
        "spectralExtent":{
            "$ref":"#/components/schemas/extentType"
        },
        "bandReference":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/segmentationDataType"
            }
        }
    },
    "required":[
        "isReferenced",
        "spectralUnit",
        "spectralExtent"
    ],
    "additionalProperties":false
}

Nested Schema : layerInfo

Type: array

Minimum Length: 1

Show Source

• Array of: object layerDescriptionType

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/layerDescriptionType"
    },
    "minLength":1
}

Nested Schema : objectDescriptionType

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "rasterType":{
            "type":"integer"
        },
        "ID":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "majorVersion":{
            "type":"string"
        },
        "minorVersion":{
            "type":"string"
        },
        "isBlank":{
            "type":"boolean",
            "default":false
        },
        "blankCellValue":{
            "type":"number"
        },
        "defaultRed":{
            "$ref":"#/components/schemas/positiveInteger"
        },
        "defaultGreen":{
            "$ref":"#/components/schemas/positiveInteger"
        },
        "defaultBlue":{
            "$ref":"#/components/schemas/positiveInteger"
        },
        "defaultAlpha":{
            "$ref":"#/components/schemas/positiveInteger"
        },
        "defaultPyramidLevel":{
            "type":"integer"
        }
    },
    "required":[
        "rasterType",
        "isBlank"
    ],
    "additionalProperties":false
}

Nested Schema : rasterDescriptionType

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "cellRepresentation":{
            "enum":[
                "POINT",
                "SEGMENT",
                "TRIANGLE",
                "SQUARE",
                "RECTANGLE",
                "CUBE",
                "TETRAHEDRON",
                "HEXAHEDRON",
                "UNDEFINED"
            ],
            "default":"UNDEFINED"
        },
        "cellDepth":{
            "enum":[
                "1BIT",
                "2BIT",
                "4BIT",
                "8BIT_U",
                "8BIT_S",
                "16BIT_U",
                "16BIT_S",
                "32BIT_U",
                "32BIT_S",
                "32BIT_REAL",
                "64BIT_REAL",
                "64BIT_COMPLEX",
                "128BIT_COMPLEX"
            ],
            "default":"8BIT_U"
        },
        "NODATA":{
            "type":"number"
        },
        "totalDimensions":{
            "type":"integer",
            "minimum":2,
            "maximum":3,
            "exclusiveMinimum":false,
            "exclusiveMaximum":false,
            "default":2
        },
        "dimensionSize":{
            "$ref":"#/components/schemas/cellDimensionSizeType"
        },
        "ULTCoordinate":{
            "$ref":"#/components/schemas/cellCoordinateType"
        },
        "blocking":{
            "$ref":"#/components/schemas/blockingDescriptionType"
        },
        "interleaving":{
            "enum":[
                "BSQ",
                "BIP",
                "BIL"
            ],
            "default":"BSQ"
        },
        "pyramid":{
            "$ref":"#/components/schemas/pyramidDescriptionType"
        },
        "compression":{
            "enum":[
                "NONE",
                "JPEG-F",
                "DEFLATE",
                "LT-MG2",
                "LT-MG3",
                "LT-JP2"
            ]
        }
    },
    "required":[
        "cellRepresentation",
        "cellDepth",
        "totalDimensions",
        "dimensionSize",
        "ULTCoordinate",
        "blocking",
        "interleaving",
        "pyramid",
        "compression"
    ],
    "additionalProperties":false
}

Nested Schema : rasterSpatialReferenceSystemType

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "isReferenced":{
            "type":"boolean",
            "default":false
        },
        "isRectified":{
            "type":"boolean"
        },
        "isOrthoRectified":{
            "type":"boolean"
        },
        "description":{
            "type":"string"
        },
        "SRID":{
            "$ref":"#/components/schemas/nonNegativeInteger",
            "default":0
        },
        "verticalSRID":{
            "type":"integer"
        },
        "modelDimensionDescription":{
            "type":"string"
        },
        "spatialResolution":{
            "$ref":"#/components/schemas/spatialResolution"
        },
        "spatialTolerance":{
            "type":"number"
        },
        "modelCoordinateLocation":{
            "enum":[
                "CENTER",
                "UPPERLEFT"
            ]
        },
        "modelType":{
            "enum":[
                "RigorousModel",
                "StoredFunction",
                "FunctionalFitting"
            ]
        },
        "polynomialModel":{
            "$ref":"#/components/schemas/rationalPolynomialType"
        },
        "gcpGeoreferenceModel":{
            "$ref":"#/components/schemas/GCPGeoreferenceType"
        },
        "gcpTableName":{
            "type":"string"
        }
    },
    "required":[
        "isReferenced",
        "SRID"
    ],
    "additionalProperties":false
}

Nested Schema : rasterTemporalReferenceSystemType

Type: object

Show Source

• beginDateTime: string
• description: string
• endDateTime: string
• isReferenced(required): boolean
  Default Value: false
• temporalResolutionDescription: string

{
    "type":"object",
    "properties":{
        "isReferenced":{
            "type":"boolean",
            "default":false
        },
        "description":{
            "type":"string"
        },
        "beginDateTime":{
            "type":"string"
        },
        "endDateTime":{
            "type":"string"
        },
        "temporalResolutionDescription":{
            "type":"string"
        }
    },
    "required":[
        "isReferenced"
    ],
    "additionalProperties":false
}

Nested Schema : bandReference

Type: array

Show Source

• Array of: object segmentationDataType

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

Nested Schema : spatialResolution

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "xResolution":{
            "type":"number",
            "default":1
        },
        "yResolution":{
            "type":"number",
            "default":1
        },
        "zResolution":{
            "type":"number",
            "default":1
        },
        "tResolution":{
            "type":"number",
            "default":1
        },
        "sResolution":{
            "type":"number",
            "default":1
        }
    },
    "additionalProperties":false
}

Nested Schema : extentType

Type: object

Show Source

• max(required): number
• min(required): number

{
    "type":"object",
    "properties":{
        "min":{
            "type":"number"
        },
        "max":{
            "type":"number"
        }
    },
    "required":[
        "min",
        "max"
    ],
    "additionalProperties":false
}

Nested Schema : segmentationDataType

Type: object

Show Source

• extent(required): object extentType
• firstSegNumber(required): integer
  Default Value: 1
• totalSegNumber(required): integer
  Minimum Value: 1

  Minimum Value: > false

{
    "type":"object",
    "properties":{
        "totalSegNumber":{
            "$ref":"#/components/schemas/positiveInteger",
            "default":1
        },
        "firstSegNumber":{
            "type":"integer",
            "default":1
        },
        "extent":{
            "$ref":"#/components/schemas/extentType"
        }
    },
    "required":[
        "totalSegNumber",
        "firstSegNumber",
        "extent"
    ],
    "additionalProperties":false
}

Nested Schema : layerDescriptionType

Type: object

Show Source

• layerDimension(required):
  Default Value: BAND

  Allowed Values: [ "ROW", "COLUMN", "VERTICAL", "BAND", "TEMPORAL" ]
• objectLayer: object layerType
• subLayer: array subLayer

{
    "type":"object",
    "properties":{
        "layerDimension":{
            "enum":[
                "ROW",
                "COLUMN",
                "VERTICAL",
                "BAND",
                "TEMPORAL"
            ],
            "default":"BAND"
        },
        "objectLayer":{
            "$ref":"#/components/schemas/layerType"
        },
        "subLayer":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/layerType"
            },
            "minLength":0
        }
    },
    "required":[
        "layerDimension"
    ],
    "additionalProperties":false
}

Nested Schema : layerType

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "layerNumber":{
            "$ref":"#/components/schemas/nonNegativeInteger"
        },
        "layerDimensionOrdinate":{
            "type":"integer"
        },
        "layerID":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "bitmapMask":{
            "type":"boolean",
            "default":false
        },
        "NODATA":{
            "$ref":"#/components/schemas/NODATAType"
        },
        "scalingFunction":{
            "$ref":"#/components/schemas/scalingFunctionType"
        },
        "binFunction":{
            "$ref":"#/components/schemas/binFunctionType"
        },
        "statisticDataset":{
            "$ref":"#/components/schemas/statisticDatasetType"
        },
        "grayScale":{
            "$ref":"#/components/schemas/grayScaleType"
        },
        "colorMap":{
            "$ref":"#/components/schemas/colorMapType"
        },
        "vatTableName":{
            "type":"string"
        }
    },
    "required":[
        "layerNumber",
        "layerDimensionOrdinate",
        "layerID"
    ],
    "additionalProperties":false
}

Nested Schema : subLayer

Type: array

Minimum Length: 0

Show Source

• Array of: object layerType

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/layerType"
    },
    "minLength":0
}

Nested Schema : binFunctionType

Type: object

Show Source

• binDefinition(required): binDefinition
• binType(required):
  Allowed Values: [ "LINEAR", "LOGARITHM", "EXPLICIT" ]

{
    "type":"object",
    "properties":{
        "binType":{
            "enum":[
                "LINEAR",
                "LOGARITHM",
                "EXPLICIT"
            ]
        },
        "binDefinition":{
            "oneOf":[
                {
                    "$ref":"#/components/schemas/segmentationDataType"
                },
                {
                    "type":"string"
                }
            ]
        }
    },
    "required":[
        "binType",
        "binDefinition"
    ],
    "additionalProperties":false
}

Nested Schema : colorMapType

Type: object

Show Source

• colors(required): colors

{
    "type":"object",
    "properties":{
        "colors":{
            "oneOf":[
                {
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/cellPseudoColorType"
                    },
                    "minLength":1
                },
                {
                    "type":"string"
                }
            ]
        }
    },
    "required":[
        "colors"
    ],
    "additionalProperties":false
}

Nested Schema : grayScaleType

Type: object

Show Source

• grays(required): grays

{
    "type":"object",
    "properties":{
        "grays":{
            "oneOf":[
                {
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/cellGrayType"
                    },
                    "minLength":1
                },
                {
                    "type":"string"
                }
            ]
        }
    },
    "required":[
        "grays"
    ],
    "additionalProperties":false
}

Nested Schema : NODATAType

Type: object

Show Source

• mask: boolean
• ranges: array ranges
• values: array values

{
    "type":"object",
    "properties":{
        "values":{
            "type":"array",
            "items":{
                "type":"number"
            }
        },
        "ranges":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/extentType"
            }
        },
        "mask":{
            "type":"boolean"
        }
    },
    "additionalProperties":false
}

Nested Schema : scalingFunctionType

Type: object

Show Source

• a0(required): number
  Default Value: 1
• a1(required): number
  Default Value: 0
• b0(required): number
  Default Value: 1
• b1(required): number
  Default Value: 0

{
    "type":"object",
    "properties":{
        "a0":{
            "type":"number",
            "default":1
        },
        "a1":{
            "type":"number",
            "default":0
        },
        "b0":{
            "type":"number",
            "default":1
        },
        "b1":{
            "type":"number",
            "default":0
        }
    },
    "required":[
        "a0",
        "a1",
        "b0",
        "b1"
    ],
    "additionalProperties":false
}

Nested Schema : statisticDatasetType

Type: object

Show Source

• histogram: object histogramType
• MAX(required): number
• MEAN(required): number
• MEDIAN(required): number
• MIN(required): number
• MODEVALUE(required): number
• samplingFactor(required): integer
  Minimum Value: 1

  Minimum Value: > false
• samplingWindow: object rectangularWindowType
• STD(required): number

{
    "type":"object",
    "properties":{
        "samplingFactor":{
            "$ref":"#/components/schemas/positiveInteger",
            "default":1
        },
        "samplingWindow":{
            "$ref":"#/components/schemas/rectangularWindowType"
        },
        "MIN":{
            "type":"number"
        },
        "MAX":{
            "type":"number"
        },
        "MEAN":{
            "type":"number"
        },
        "MEDIAN":{
            "type":"number"
        },
        "MODEVALUE":{
            "type":"number"
        },
        "STD":{
            "type":"number"
        },
        "histogram":{
            "$ref":"#/components/schemas/histogramType"
        }
    },
    "required":[
        "samplingFactor",
        "MIN",
        "MAX",
        "MEAN",
        "MEDIAN",
        "MODEVALUE",
        "STD"
    ],
    "additionalProperties":false
}

Nested Schema : binDefinition

Match One Schema

Show Source

• object segmentationDataType
• string

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/segmentationDataType"
        },
        {
            "type":"string"
        }
    ]
}

Nested Schema : colors

Match One Schema

Show Source

• array colors-oneOf[0]
• string

{
    "oneOf":[
        {
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/cellPseudoColorType"
            },
            "minLength":1
        },
        {
            "type":"string"
        }
    ]
}

Nested Schema : colors-oneOf[0]

Type: array

Minimum Length: 1

Show Source

• Array of: object cellPseudoColorType

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/cellPseudoColorType"
    },
    "minLength":1
}

Nested Schema : cellPseudoColorType

Type: object

Show Source

• alpha: number
• blue(required): integer
• green(required): integer
• red(required): integer
• value(required): number

{
    "type":"object",
    "properties":{
        "value":{
            "type":"number"
        },
        "red":{
            "type":"integer"
        },
        "green":{
            "type":"integer"
        },
        "blue":{
            "type":"integer"
        },
        "alpha":{
            "type":"number"
        }
    },
    "required":[
        "value",
        "red",
        "green",
        "blue"
    ],
    "additionalProperties":false
}

Nested Schema : grays

Match One Schema

Show Source

• array grays-oneOf[0]
• string

{
    "oneOf":[
        {
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/cellGrayType"
            },
            "minLength":1
        },
        {
            "type":"string"
        }
    ]
}

Nested Schema : grays-oneOf[0]

Type: array

Minimum Length: 1

Show Source

• Array of: object cellGrayType

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/cellGrayType"
    },
    "minLength":1
}

Nested Schema : cellGrayType

Type: object

Show Source

• gray(required): integer
• value(required): number

{
    "type":"object",
    "properties":{
        "value":{
            "type":"number"
        },
        "gray":{
            "type":"integer"
        }
    },
    "required":[
        "value",
        "gray"
    ],
    "additionalProperties":false
}

Nested Schema : ranges

Type: array

Show Source

• Array of: object extentType

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

Nested Schema : values

Type: array

Show Source

• Array of: number

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

Nested Schema : histogramType

Type: object

Show Source

• counts(required): counts

{
    "type":"object",
    "properties":{
        "counts":{
            "oneOf":[
                {
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/cellCountType"
                    },
                    "minLength":1
                },
                {
                    "type":"string"
                }
            ]
        }
    },
    "required":[
        "counts"
    ],
    "additionalProperties":false
}

Nested Schema : rectangularWindowType

Type: object

Show Source

• columnWidth(required): integer
  Minimum Value: 1

  Minimum Value: > false
• origin(required): object cellCoordinateType
• rowHeight(required): integer
  Minimum Value: 1

  Minimum Value: > false

{
    "type":"object",
    "properties":{
        "origin":{
            "$ref":"#/components/schemas/cellCoordinateType"
        },
        "rowHeight":{
            "$ref":"#/components/schemas/positiveInteger"
        },
        "columnWidth":{
            "$ref":"#/components/schemas/positiveInteger"
        }
    },
    "required":[
        "origin",
        "rowHeight",
        "columnWidth"
    ],
    "additionalProperties":false
}

Nested Schema : counts

Match One Schema

Show Source

• array counts-oneOf[0]
• string

{
    "oneOf":[
        {
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/cellCountType"
            },
            "minLength":1
        },
        {
            "type":"string"
        }
    ]
}

Nested Schema : counts-oneOf[0]

Type: array

Minimum Length: 1

Show Source

• Array of: object cellCountType

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/cellCountType"
    },
    "minLength":1
}

Nested Schema : cellCountType

Type: object

Show Source

• count(required): integer
  Minimum Value: 0

  Minimum Value: > false
• value(required): number

{
    "type":"object",
    "properties":{
        "value":{
            "type":"number"
        },
        "count":{
            "$ref":"#/components/schemas/nonNegativeInteger"
        }
    },
    "required":[
        "value",
        "count"
    ],
    "additionalProperties":false
}

Nested Schema : cellCoordinateType

Type: object

Show Source

• bandCellCoordinate: integer
• columnCellCoordinate(required): integer
  Default Value: 0
• rowCellCoordinate(required): integer
  Default Value: 0
• temporalCellCoordinate: integer
• verticalCellCoordinate: integer

{
    "type":"object",
    "properties":{
        "rowCellCoordinate":{
            "type":"integer",
            "default":0
        },
        "columnCellCoordinate":{
            "type":"integer",
            "default":0
        },
        "bandCellCoordinate":{
            "type":"integer"
        },
        "verticalCellCoordinate":{
            "type":"integer"
        },
        "temporalCellCoordinate":{
            "type":"integer"
        }
    },
    "required":[
        "rowCellCoordinate",
        "columnCellCoordinate"
    ],
    "additionalProperties":false
}

Nested Schema : blockingDescriptionType

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "blockingType":{
            "enum":[
                "NONE",
                "REGULAR"
            ],
            "default":"NONE"
        },
        "totalRowBlocks":{
            "$ref":"#/components/schemas/positiveInteger",
            "default":1
        },
        "totalColumnBlocks":{
            "$ref":"#/components/schemas/positiveInteger",
            "default":1
        },
        "totalBandBlocks":{
            "$ref":"#/components/schemas/positiveInteger",
            "default":1
        },
        "rowBlockSize":{
            "$ref":"#/components/schemas/positiveInteger"
        },
        "columnBlockSize":{
            "$ref":"#/components/schemas/positiveInteger"
        },
        "bandBlockSize":{
            "$ref":"#/components/schemas/positiveInteger"
        }
    },
    "required":[
        "blockingType",
        "totalRowBlocks",
        "totalColumnBlocks",
        "rowBlockSize",
        "columnBlockSize"
    ],
    "additionalProperties":false
}

Nested Schema : cellDimensionSizeType

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "rowDimensionSize":{
            "$ref":"#/components/schemas/positiveInteger",
            "default":1
        },
        "columnDimensionSize":{
            "$ref":"#/components/schemas/positiveInteger",
            "default":1
        },
        "bandDimensionSize":{
            "$ref":"#/components/schemas/positiveInteger",
            "default":1
        },
        "verticalDimensionSize":{
            "$ref":"#/components/schemas/positiveInteger",
            "default":1
        },
        "temporalDimensionSize":{
            "$ref":"#/components/schemas/positiveInteger",
            "default":1
        }
    },
    "required":[
        "rowDimensionSize",
        "columnDimensionSize"
    ],
    "additionalProperties":false
}

Nested Schema : pyramidDescriptionType

Type: object

Show Source

• 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" ]

{
    "type":"object",
    "properties":{
        "pyramidType":{
            "enum":[
                "NONE",
                "DECREASE",
                "INCREASE",
                "BIDIRECTION"
            ],
            "default":"NONE"
        },
        "resampling":{
            "enum":[
                "NN",
                "BILINEAR",
                "CUBIC",
                "AVERAGE4",
                "AVERAGE16",
                "BIQUADRATIC",
                "OTHER"
            ],
            "default":"NN"
        },
        "maxLevel":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/nonNegativeInteger"
                }
            ],
            "default":0
        }
    },
    "required":[
        "pyramidType"
    ],
    "additionalProperties":false
}

Nested Schema : maxLevel

Default Value: 0

Match All

Show Source

• integer
  Minimum Value: 0

  Minimum Value: > false

{
    "allOf":[
        {
            "$ref":"#/components/schemas/nonNegativeInteger"
        }
    ],
    "default":0
}

Nested Schema : GCPGeoreferenceType

Type: object

Show Source

• FFMethod:
  Allowed Values: [ "Affine", "QuadraticPolynomial", "CubicPolynomial", "DLT", "QuadraticRational", "RPC" ]
• gcp(required): array gcp

{
    "type":"object",
    "properties":{
        "gcp":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/GCPType"
            },
            "minLength":0
        },
        "FFMethod":{
            "enum":[
                "Affine",
                "QuadraticPolynomial",
                "CubicPolynomial",
                "DLT",
                "QuadraticRational",
                "RPC"
            ]
        }
    },
    "required":[
        "gcp"
    ],
    "additionalProperties":false
}

Nested Schema : rationalPolynomialType

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "pPolynomial":{
            "$ref":"#/components/schemas/polynomialType"
        },
        "qPolynomial":{
            "$ref":"#/components/schemas/polynomialType"
        },
        "rPolynomial":{
            "$ref":"#/components/schemas/polynomialType"
        },
        "sPolynomial":{
            "$ref":"#/components/schemas/polynomialType"
        },
        "rowOff":{
            "type":"number"
        },
        "columnOff":{
            "type":"number"
        },
        "xOff":{
            "type":"number"
        },
        "yOff":{
            "type":"number"
        },
        "zOff":{
            "type":"number"
        },
        "rowScale":{
            "type":"number"
        },
        "columnScale":{
            "type":"number"
        },
        "xScale":{
            "type":"number"
        },
        "yScale":{
            "type":"number"
        },
        "zScale":{
            "type":"number"
        },
        "rowRMS":{
            "type":"number"
        },
        "columnRMS":{
            "type":"number"
        },
        "totalRMS":{
            "type":"number"
        },
        "xRMS":{
            "type":"number"
        },
        "yRMS":{
            "type":"number"
        },
        "zRMS":{
            "type":"number"
        },
        "modelTotalRMS":{
            "type":"number"
        }
    },
    "required":[
        "pPolynomial",
        "qPolynomial",
        "rPolynomial",
        "sPolynomial",
        "rowOff",
        "columnOff",
        "xOff",
        "yOff",
        "zOff",
        "rowScale",
        "columnScale",
        "xScale",
        "yScale",
        "zScale"
    ],
    "additionalProperties":false
}

Nested Schema : gcp

Type: array

Minimum Length: 0

Show Source

• Array of: object GCPType

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/GCPType"
    },
    "minLength":0
}

Nested Schema : GCPType

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "ID":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "gcpPointType":{
            "enum":[
                "ControlPoint",
                "CheckPoint"
            ]
        },
        "cellDimension":{
            "$ref":"#/components/schemas/nonNegativeInteger"
        },
        "row":{
            "type":"number",
            "default":0
        },
        "column":{
            "type":"number",
            "default":0
        },
        "vertical":{
            "type":"integer"
        },
        "modelDimension":{
            "$ref":"#/components/schemas/nonNegativeInteger"
        },
        "X":{
            "type":"number",
            "default":0
        },
        "Y":{
            "type":"number",
            "default":0
        },
        "Z":{
            "type":"number"
        },
        "xRMS":{
            "type":"number"
        },
        "yRMS":{
            "type":"number"
        },
        "zRMS":{
            "type":"number"
        },
        "status":{
            "enum":[
                "Measured",
                "Removed",
                "Estimated",
                "Validated",
                "Invalid"
            ]
        }
    },
    "required":[
        "gcpPointType",
        "cellDimension",
        "row",
        "column",
        "modelDimension",
        "X",
        "Y"
    ],
    "additionalProperties":false
}

Nested Schema : polynomialType

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "polynomialCoefficients":{
            "type":"array",
            "items":{
                "type":"number"
            }
        },
        "pType":{
            "$ref":"#/components/schemas/nonNegativeInteger",
            "default":1
        },
        "nVars":{
            "$ref":"#/components/schemas/nonNegativeInteger"
        },
        "order":{
            "$ref":"#/components/schemas/nonNegativeInteger"
        },
        "nCoefficients":{
            "$ref":"#/components/schemas/nonNegativeInteger"
        }
    },
    "required":[
        "polynomialCoefficients",
        "nVars",
        "order",
        "nCoefficients"
    ],
    "additionalProperties":false
}

Nested Schema : polynomialCoefficients

Type: array

Show Source

• Array of: number

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

Examples

Select an example example with two item elements

401 Response

Authentication information is missing or invalid

Headers

• WWW_Authenticate:

Back to Top

Examples

The following is an example on how to list the GeoRaster Objects from data source datasource1 table image_table and column image by submitting a GET request using cURL.

curl -X GET "https://localhost:8080/oraclespatial/georaster/v1/datasource1/image_table/image?limit=2&offset=0" -H "Cookie: JSESSIONID=<jsessionid_value>"

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

{
   "items" : [ {
     "rasterType" : 21001,
     "spatialExtent" : null,
     "rasterDataTable" : "IMAGE_TABLE_RDT1",
     "rasterID" : 1,
     "links" : [ {
       "rel" : "self",
       "href" : "http://localhost:8080/oraclespatial/georaster/v1/datasource1/image_table/image/image_table_rdt1/1"
     }, {
       "rel" : "metadata",
       "href" : "http://localhost:8080/oraclespatial/georaster/v1/datasource1/image_table/image/image_table_rdt1/1/metadata"
     } ]
   }, {
     "rasterType" : 21001,
     "spatialExtent" : null,
     "rasterDataTable" : "IMAGE_TABLE_RDT1",
     "rasterID" : 2,
     "links" : [ {
       "rel" : "self",
       "href" : "http://localhost:8080/oraclespatial/georaster/v1/datasource1/image_table/image/image_table_rdt1/2"
     }, {
       "rel" : "metadata",
       "href" : "http://localhost:8080/oraclespatial/georaster/v1/datasource1/image_table/image/image_table_rdt1/2/metadata"
     } ]
   },
   "hasMore" : true,
   "totalResults" : 16,
   "links" : [ {
     "rel" : "canonical",
       "href" : "http://localhost:8080/oraclespatial/georaster/v1/datasource1/image_table/image"
   }, {
     "rel" : "self",
       "href" : "http://localhost:8080/oraclespatial/georaster/v1/datasource1/image_table/image?limit=2&offset=0"
   }, {
     "rel" : "next",
       "href" : "http://localhost:8080/oraclespatial/georaster/v1/datasource1/image_table/image?limit=2&offset=2"
   } ]
  } 

Back to Top