REST API for Big Data Spatial and Graph

List the metadata of the loaded images in HDFS

get

/spatialviewer/api/v1/raster/hdfs/imagery

Request

There are no request parameters for this operation.

Response

Supported Media Types

application/json

200 Response

successful request

Root Schema : RasterImagenarySuccessResponse

Type: object

Show Source

o:successCode(optional): string

Success code.

Example: SVR-00204
response(optional): object response

Response details
status(optional): string

success or error

Example: success
title(optional): string

Response description

Example: HDFS File found.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"success or error",
            "example":"success"
        },
        "title":{
            "type":"string",
            "description":"Response description",
            "example":"HDFS File found."
        },
        "o:successCode":{
            "type":"string",
            "description":"Success code.",
            "example":"SVR-00204"
        },
        "response":{
            "type":"object",
            "description":"Response details",
            "properties":{
                "message":{
                    "type":"string",
                    "description":"Response description",
                    "example":"HDFS file found"
                },
                "items":{
                    "type":"object",
                    "description":"Geometry and other details of each loaded raster",
                    "properties":{
                        "type":{
                            "type":"string",
                            "description":"Geometry type",
                            "example":"FeatureCollection"
                        },
                        "srs":{
                            "type":"number",
                            "description":"SRID value",
                            "example":4326
                        },
                        "geodetic":{
                            "type":"boolean",
                            "description":"Determines if features are geodetic or not",
                            "example":true
                        },
                        "bbox":{
                            "type":"array",
                            "description":"Features boundaries",
                            "items":{
                                "type":"integer",
                                "format":"float32",
                                "example":[
                                    -156.7365369244308,
                                    -156.7365369244308,
                                    20.555967454272203,
                                    -155.94583285721743,
                                    21.05401626275324
                                ]
                            }
                        },
                        "features":{
                            "type":"array",
                            "items":{
                                "$ref":"#/definitions/FeatureDetailObject"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : response

Type: object

Response details

Show Source

items(optional): object items

Geometry and other details of each loaded raster
message(optional): string

Response description

Example: HDFS file found

{
    "type":"object",
    "description":"Response details",
    "properties":{
        "message":{
            "type":"string",
            "description":"Response description",
            "example":"HDFS file found"
        },
        "items":{
            "type":"object",
            "description":"Geometry and other details of each loaded raster",
            "properties":{
                "type":{
                    "type":"string",
                    "description":"Geometry type",
                    "example":"FeatureCollection"
                },
                "srs":{
                    "type":"number",
                    "description":"SRID value",
                    "example":4326
                },
                "geodetic":{
                    "type":"boolean",
                    "description":"Determines if features are geodetic or not",
                    "example":true
                },
                "bbox":{
                    "type":"array",
                    "description":"Features boundaries",
                    "items":{
                        "type":"integer",
                        "format":"float32",
                        "example":[
                            -156.7365369244308,
                            -156.7365369244308,
                            20.555967454272203,
                            -155.94583285721743,
                            21.05401626275324
                        ]
                    }
                },
                "features":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/FeatureDetailObject"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Geometry and other details of each loaded raster

Show Source

bbox(optional): array bbox

Features boundaries
features(optional): array features
geodetic(optional): boolean

Determines if features are geodetic or not

Example: true
srs(optional): number

SRID value

Example: 4326
type(optional): string

Geometry type

Example: FeatureCollection

{
    "type":"object",
    "description":"Geometry and other details of each loaded raster",
    "properties":{
        "type":{
            "type":"string",
            "description":"Geometry type",
            "example":"FeatureCollection"
        },
        "srs":{
            "type":"number",
            "description":"SRID value",
            "example":4326
        },
        "geodetic":{
            "type":"boolean",
            "description":"Determines if features are geodetic or not",
            "example":true
        },
        "bbox":{
            "type":"array",
            "description":"Features boundaries",
            "items":{
                "type":"integer",
                "format":"float32",
                "example":[
                    -156.7365369244308,
                    -156.7365369244308,
                    20.555967454272203,
                    -155.94583285721743,
                    21.05401626275324
                ]
            }
        },
        "features":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/FeatureDetailObject"
            }
        }
    }
}

Nested Schema : bbox

Type: array

Features boundaries

Show Source

Array of: integer(float32)

Example: [ -156.7365369244308, -156.7365369244308, 20.555967454272203, -155.94583285721743, 21.05401626275324 ]

{
    "type":"array",
    "description":"Features boundaries",
    "items":{
        "type":"integer",
        "format":"float32",
        "example":[
            -156.7365369244308,
            -156.7365369244308,
            20.555967454272203,
            -155.94583285721743,
            21.05401626275324
        ]
    }
}

Nested Schema : features

Type: array

Show Source

Array of: object FeatureDetailObject

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/FeatureDetailObject"
    }
}

Nested Schema : FeatureDetailObject

Type: object

Show Source

geometry(optional): object geometry

Feature geometry details
properties(optional): object properties

Feature properties
type(optional): string

Feature type

Example: Feature

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"Feature type",
            "example":"Feature"
        },
        "geometry":{
            "type":"object",
            "description":"Feature geometry details",
            "properties":{
                "type":{
                    "type":"string",
                    "description":"Feature type",
                    "example":"Polygon"
                },
                "coordinates":{
                    "type":"array",
                    "items":{
                        "type":"array",
                        "items":{
                            "type":"array",
                            "items":{
                                "type":"number",
                                "format":"double"
                            },
                            "example":[
                                -122.62545489427995,
                                38.57117909890767
                            ]
                        }
                    }
                }
            }
        },
        "properties":{
            "type":"object",
            "description":"Feature properties",
            "properties":{
                "srid":{
                    "type":"number",
                    "description":"Feature SRID",
                    "example":32610
                },
                "thumbpath":{
                    "type":"string",
                    "description":"Thumbnail folder location",
                    "example":"/usr/oracle/spatialviewer/workingdir/raster/thumb"
                },
                "width":{
                    "type":"number",
                    "description":"Feature width",
                    "example":1800
                },
                "height":{
                    "type":"number",
                    "description":"Feature height",
                    "example":1202.000000000008
                },
                "file":{
                    "type":"string",
                    "description":"Raster source file in a special format",
                    "example":"/usr/oracle/spatialviewer/workingdir/raster/raster.tif.ohif"
                },
                "resolution":{
                    "type":"object",
                    "description":"Feature resolution details",
                    "properties":{
                        "resolutionX":{
                            "type":"number",
                            "description":"Feature resolution X",
                            "example":27.90809458890406
                        },
                        "resolutionY":{
                            "type":"number",
                            "description":"Feature resolution Y",
                            "example":-27.90809458890406
                        }
                    }
                },
                "datatype":{
                    "type":"string",
                    "description":"Feature data type value",
                    "example":6
                },
                "bands":{
                    "type":"string",
                    "description":"Feature bands value",
                    "example":1
                }
            }
        }
    }
}

Nested Schema : geometry

Type: object

Feature geometry details

Show Source

coordinates(optional): array coordinates
type(optional): string

Feature type

Example: Polygon

{
    "type":"object",
    "description":"Feature geometry details",
    "properties":{
        "type":{
            "type":"string",
            "description":"Feature type",
            "example":"Polygon"
        },
        "coordinates":{
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"array",
                    "items":{
                        "type":"number",
                        "format":"double"
                    },
                    "example":[
                        -122.62545489427995,
                        38.57117909890767
                    ]
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Feature properties

Show Source

bands(optional): string

Feature bands value

Example: 1
datatype(optional): string

Feature data type value

Example: 6
file(optional): string

Raster source file in a special format

Example: /usr/oracle/spatialviewer/workingdir/raster/raster.tif.ohif
height(optional): number

Feature height

Example: 1202.000000000008
resolution(optional): object resolution

Feature resolution details
srid(optional): number

Feature SRID

Example: 32610
thumbpath(optional): string

Thumbnail folder location

Example: /usr/oracle/spatialviewer/workingdir/raster/thumb
width(optional): number

Feature width

Example: 1800

{
    "type":"object",
    "description":"Feature properties",
    "properties":{
        "srid":{
            "type":"number",
            "description":"Feature SRID",
            "example":32610
        },
        "thumbpath":{
            "type":"string",
            "description":"Thumbnail folder location",
            "example":"/usr/oracle/spatialviewer/workingdir/raster/thumb"
        },
        "width":{
            "type":"number",
            "description":"Feature width",
            "example":1800
        },
        "height":{
            "type":"number",
            "description":"Feature height",
            "example":1202.000000000008
        },
        "file":{
            "type":"string",
            "description":"Raster source file in a special format",
            "example":"/usr/oracle/spatialviewer/workingdir/raster/raster.tif.ohif"
        },
        "resolution":{
            "type":"object",
            "description":"Feature resolution details",
            "properties":{
                "resolutionX":{
                    "type":"number",
                    "description":"Feature resolution X",
                    "example":27.90809458890406
                },
                "resolutionY":{
                    "type":"number",
                    "description":"Feature resolution Y",
                    "example":-27.90809458890406
                }
            }
        },
        "datatype":{
            "type":"string",
            "description":"Feature data type value",
            "example":6
        },
        "bands":{
            "type":"string",
            "description":"Feature bands value",
            "example":1
        }
    }
}

Nested Schema : coordinates

Type: array

Show Source

Array of: array items

{
    "type":"array",
    "items":{
        "type":"array",
        "items":{
            "type":"array",
            "items":{
                "type":"number",
                "format":"double"
            },
            "example":[
                -122.62545489427995,
                38.57117909890767
            ]
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: array items

{
    "type":"array",
    "items":{
        "type":"array",
        "items":{
            "type":"number",
            "format":"double"
        },
        "example":[
            -122.62545489427995,
            38.57117909890767
        ]
    }
}

Nested Schema : items

Type: array

Show Source

Array of: number(double)

{
    "type":"array",
    "items":{
        "type":"number",
        "format":"double"
    },
    "example":[
        -122.62545489427995,
        38.57117909890767
    ]
}

Example:

[
    -122.62545489427995,
    38.57117909890767
]

Nested Schema : resolution

Type: object

Feature resolution details

Show Source

resolutionX(optional): number

Feature resolution X

Example: 27.90809458890406
resolutionY(optional): number

Feature resolution Y

Example: -27.90809458890406

{
    "type":"object",
    "description":"Feature resolution details",
    "properties":{
        "resolutionX":{
            "type":"number",
            "description":"Feature resolution X",
            "example":27.90809458890406
        },
        "resolutionY":{
            "type":"number",
            "description":"Feature resolution Y",
            "example":-27.90809458890406
        }
    }
}

404 Response

metadata folder does not found in HDFS

Root Schema : RasterImagenaryMetadataNotFoundResponse

Type: object

Show Source

detail(optional): string

error detail

Example: Unable to locate the imagery metadata folder
o:successCode(optional): string

Success code.

Example: SVR-E0002
status(optional): string

success or error

Example: error
title(optional): string

Response description

Example: Unable to locate the imagery metadata folder.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"success or error",
            "example":"error"
        },
        "title":{
            "type":"string",
            "description":"Response description",
            "example":"Unable to locate the imagery metadata folder."
        },
        "o:successCode":{
            "type":"string",
            "description":"Success code.",
            "example":"SVR-E0002"
        },
        "detail":{
            "type":"string",
            "description":"error detail",
            "example":"Unable to locate the imagery metadata folder"
        }
    }
}

Examples

List the metadata of the loaded images in HDFS that were upload using the SpatialViewer Raster load UI or the Spatial Raster API. The images are retrived from the metadata generated from the Spatial Raster API inside HDFS.

The following example shows how to get the raster imagery by submitting a GET request on the REST resource using cURL.

curl -X GET "http://localhost:8045/spatialviewer/api/v1/raster/hdfs/imagery" -H "accept: application/json"

Example of Response Header

HTTP/1.1 200 OK Date: Tue, 21 Aug 2018 22:17:12 GMT Content-Type: application/json Access-Control-Allow-Origin: * Access-Control-Allow-Credentials: true Access-Control-Allow-Methods: GET, POST, DELETE, PUT Access-Control-Allow-Headers: Content-Type, Accept Transfer-Encoding: chunked

Example of the Response Body

The following example shows the contents of the response body in JSON format

{ "status" : "success", "title" : "HDFS File found.", "o:successCode" : "SVR-00204", "response" : { "message" : "HDFS file found", "items" : { "type" : "FeatureCollection", "srs" : 4326, "geodetic" : true, "bbox" : [ -156.7365369244308, 18.875729817164682, -70.95227337202385, 42.62245107721305 ], "features" : [ { "type" : "Feature", "geometry" : { "type" : "Polygon", "coordinates" : [ [ [ -71.07506153586199, 42.35106049624377 ], [ -71.07506153586199, 42.61945506336008 ], [ -70.95695868641145, 42.61945506336008 ], [ -70.95695868641145, 42.35106049624377 ] ] ] }, "properties" : { "srid" : 26986, "thumbpath" : "/net/den00btb/scratch/zherena/test/write/thumb/", "width" : 1800.0, "height" : 5421.999999999994, "file" : "/user/hdfs/upload/InitialFilter.tif.ohif", "resolution" : { "resolutionX" : 5.488334768766928, "resolutionY" : -5.488334768766928 }, "datatype" : "3", "bands" : "1" } }, { "type" : "Feature", "geometry" : { "type" : "Polygon", "coordinates" : [ [ [ -156.6949111088139, 18.875729817164682 ], [ -156.6949111088139, 20.291695517490766 ], [ -154.52586689541084, 20.291695517490766 ], [ -154.52586689541084, 18.875729817164682 ] ] ] }, "properties" : { "srid" : 26904, "thumbpath" : "/net/den01spo/scratch/swap/spatialviewer//thumb/", "width" : 3200.0, "height" : 2111.9999999999995, "file" : "/user/hdfs/upload/net/den01spo/scratch/swap/spatialviewer/data/rasters/hawaii.tif.ohif", "resolution" : { "resolutionX" : 72.15792877633619, "resolutionY" : -72.15792877633619 }, "datatype" : "1", "bands" : "3" } }, { "type" : "Feature", "geometry" : { "type" : "Polygon", "coordinates" : [ [ [ -156.7365369244308, 20.555967454272203 ], [ -156.7365369244308, 21.05401626275324 ], [ -155.94583285721743, 21.05401626275324 ], [ -155.94583285721743, 20.555967454272203 ] ] ] }, "properties" : { "srid" : 26904, "thumbpath" : "/net/den01spo/scratch/swap/spatialviewer//thumb/", "width" : 3200.0, "height" : 2067.999999999997, "file" : "/user/hdfs/upload/maui.tif.ohif", "resolution" : { "resolutionX" : 26.018635967341105, "resolutionY" : -26.018635967341105 }, "datatype" : "1", "bands" : "3" } }, { "type" : "Feature", "geometry" : { "type" : "Polygon", "coordinates" : [ [ [ -156.2660953491551, 19.71021898876328 ], [ -156.2660953491551, 20.844040806598937 ], [ -155.23338624125736, 20.844040806598937 ], [ -155.23338624125736, 19.71021898876328 ] ] ] }, "properties" : { "srid" : 26904, "thumbpath" : "/net/den01spo/scratch/swap/spatialviewer/thumb/", "width" : 1800.0, "height" : 2012.9999999999998, "file" : "/testhdfs.tif.ohif", "resolution" : { "resolutionX" : 61.35444695778262, "resolutionY" : -61.35444695778262 }, "datatype" : "1", "bands" : "3" } }, { "type" : "Feature", "geometry" : { "type" : "Polygon", "coordinates" : [ [ [ -71.07837068219838, 42.34799416281842 ], [ -71.07837068219838, 42.62245107721305 ], [ -70.95477454709828, 42.62245107721305 ], [ -70.95477454709828, 42.34799416281842 ] ] ] }, "properties" : { "srid" : 26986, "thumbpath" : "/net/den01spo/scratch/swap/spatialviewer//thumb/", "width" : 1800.0, "height" : 5300.000000000001, "file" : "/user/hdfs/upload/bostonFilter.tif.ohif", "resolution" : { "resolutionX" : 5.741255260017998, "resolutionY" : -5.741255260017998 }, "datatype" : "3", "bands" : "1" } }, { "type" : "Feature", "geometry" : { "type" : "Polygon", "coordinates" : [ [ [ -71.07337795557184, 42.52915380226499 ], [ -71.07337795557184, 42.61968939631627 ], [ -70.95227337202385, 42.61968939631627 ], [ -70.95227337202385, 42.52915380226499 ] ] ] }, "properties" : { "srid" : 26986, "thumbpath" : "/net/den00btb/scratch/zherena/test/write/thumb/", "width" : 5000.0, "height" : 5000.0, "file" : "/user/hdfs/upload/Middleton.tif.ohif", "resolution" : { "resolutionX" : 2.0, "resolutionY" : -2.0 }, "datatype" : "3", "bands" : "1" } }, { "type" : "Feature", "geometry" : { "type" : "Polygon", "coordinates" : [ [ [ -156.6949111088139, 18.875729817164682 ], [ -156.6949111088139, 20.291695517490766 ], [ -154.52586689541084, 20.291695517490766 ], [ -154.52586689541084, 18.875729817164682 ] ] ] }, "properties" : { "srid" : 26904, "thumbpath" : "/net/den01spo/scratch/swap/spatialviewer//thumb/", "width" : 3200.0, "height" : 2111.9999999999995, "file" : "/user/hdfs/upload/hawaii.tif.ohif", "resolution" : { "resolutionX" : 72.15792877633619, "resolutionY" : -72.15792877633619 }, "datatype" : "1", "bands" : "3" } }, { "type" : "Feature", "geometry" : { "type" : "Polygon", "coordinates" : [ [ [ -71.0745931728542, 42.34919530993025 ], [ -71.0745931728542, 42.439733708697005 ], [ -70.9538313144653, 42.439733708697005 ], [ -70.9538313144653, 42.34919530993025 ] ] ] }, "properties" : { "srid" : 26986, "thumbpath" : "/net/den00btb/scratch/zherena/test/write/thumb/", "width" : 5000.0, "height" : 5000.0, "file" : "/user/hdfs/upload/Boston.tif.ohif", "resolution" : { "resolutionX" : 2.0, "resolutionY" : -2.0 }, "datatype" : "3", "bands" : "1" } }, { "type" : "Feature", "geometry" : { "type" : "Polygon", "coordinates" : [ [ [ -71.07398612685965, 42.43922057333476 ], [ -71.07398612685965, 42.529757679924224 ], [ -70.95305306297216, 42.529757679924224 ], [ -70.95305306297216, 42.43922057333476 ] ] ] }, "properties" : { "srid" : 26986, "thumbpath" : "/net/den00btb/scratch/zherena/test/write/thumb/", "width" : 5000.0, "height" : 5000.0, "file" : "/user/hdfs/upload/Saugus.tif.ohif", "resolution" : { "resolutionX" : 2.0, "resolutionY" : -2.0 }, "datatype" : "3", "bands" : "1" } }, { "type" : "Feature", "geometry" : { "type" : "Polygon", "coordinates" : [ [ [ -122.62545489427995, 38.57117909890767 ], [ -122.62545489427995, 38.87673549107142 ], [ -122.05038927194073, 38.87673549107142 ], [ -122.05038927194073, 38.57117909890767 ] ] ] }, "properties" : { "srid" : 32610, "thumbpath" : "/net/den00btb/scratch/zherena/test/write/thumb/", "width" : 1800.0, "height" : 1202.000000000008, "file" : "/user/hdfs/upload/NapaDEM.tif.ohif", "resolution" : { "resolutionX" : 27.90809458890406, "resolutionY" : -27.90809458890406 }, "datatype" : "6", "bands" : "1" } } ] } }}