Jump to

• Request
• Response
• Examples

Retrieves the supported gdal formats for the raster operation

get

/spatialviewer/api/v1/raster/gdalFormats/{rasterOperation}

Request

Path Parameters

• rasterOperation: string
  The raster operation name (process, load)

Back to Top

Response

Supported Media Types

• application/json

200 Response

successful request

Body ()

Root Schema : RasterGdalFormatsSuccessResponse

Type: object

Show Source

• o:successCode(optional): string
  Success code.

  Example: SVR-00209
• response(optional): object response
  Response details information with the format details
• status(optional): string
  success or error

  Example: sucess
• title(optional): string
  Response description

  Example: GDAL supported formats for operation type retrieved successfully.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"success or error",
            "example":"sucess"
        },
        "title":{
            "type":"string",
            "description":"Response description",
            "example":"GDAL supported formats for operation type retrieved successfully."
        },
        "o:successCode":{
            "type":"string",
            "description":"Success code.",
            "example":"SVR-00209"
        },
        "response":{
            "type":"object",
            "description":"Response details information with the format details",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/RasterGdalFormatDetails"
                    }
                }
            }
        }
    }
}

Nested Schema : response

Type: object

Response details information with the format details

Show Source

• items(optional): array items

{
    "type":"object",
    "description":"Response details information with the format details",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/RasterGdalFormatDetails"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object RasterGdalFormatDetails

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

Nested Schema : RasterGdalFormatDetails

Type: object

Show Source

• bands(optional): array bands
• extensions: array extensions
• inputOutputSrids(optional): object inputOutputSrids
  Object with details of the input SRID and the output SRID after select this format in a raster operation. Object keys are dynamic values.
• loader: boolean
  Determines if this format is compatible with the raster loader api.

  Example: true
• outputDataType(optional): number
  Denotates the final data type of the output after this format is select in a raster operation.

  Example: 64
• secondLoader: boolean
  Determines if this format is capable to be upload to a hdfs after a raster process.

  Example: true
• value: string
  Format general name

  Example: GTIFF

{
    "type":"object",
    "properties":{
        "extensions":{
            "type":"array",
            "items":{
                "type":"string",
                "description":"Details the output format extension after select this format in a raster operation. '/' is used as a wildcard to denotate that the format outputs to a folder instead a single file.",
                "example":[
                    "tif",
                    "/"
                ]
            }
        },
        "secondLoader":{
            "type":"boolean",
            "description":"Determines if this format is capable to be upload to a hdfs after a raster process.",
            "example":true
        },
        "loader":{
            "type":"boolean",
            "description":"Determines if this format is compatible with the raster loader api.",
            "example":true
        },
        "bands":{
            "type":"array",
            "items":{
                "type":"number",
                "description":"Specify the bands limitations about the format",
                "example":[
                    1
                ]
            }
        },
        "outputDataType":{
            "type":"number",
            "description":"Denotates the final data type of the output after this format is select in a raster operation.",
            "example":64
        },
        "value":{
            "type":"string",
            "description":"Format general name",
            "example":"GTIFF"
        },
        "inputOutputSrids":{
            "type":"object",
            "description":"Object with details of the input SRID and the output SRID after select this format in a raster operation. Object keys are dynamic values.",
            "example":{
                "26904":4269
            }
        }
    },
    "required":[
        "extensions",
        "secondLoader",
        "loader",
        "value"
    ]
}

Nested Schema : bands

Type: array

Show Source

• Array of: number
  Specify the bands limitations about the format

  Example: [ 1 ]

{
    "type":"array",
    "items":{
        "type":"number",
        "description":"Specify the bands limitations about the format",
        "example":[
            1
        ]
    }
}

Nested Schema : extensions

Type: array

Show Source

• Array of: string
  Details the output format extension after select this format in a raster operation. '/' is used as a wildcard to denotate that the format outputs to a folder instead a single file.

  Example: [ "tif", "/" ]

{
    "type":"array",
    "items":{
        "type":"string",
        "description":"Details the output format extension after select this format in a raster operation. '/' is used as a wildcard to denotate that the format outputs to a folder instead a single file.",
        "example":[
            "tif",
            "/"
        ]
    }
}

Nested Schema : inputOutputSrids

Type: object

Object with details of the input SRID and the output SRID after select this format in a raster operation. Object keys are dynamic values.

Example:

{
    "26904":4269
}

400 Response

invalid raster operation request

Body ()

Root Schema : RasterGdalFormatsInvalidOperationResponse

Type: object

Show Source

• detail(optional): string
  Available raster operation parameters

  Example: Invalid parameters. Supported raster operations: load, process
• o:errorCode(optional): string
  Error code.

  Example: SVR-E0018
• status(optional): string
  success or error

  Example: error
• title(optional): string
  Response description

  Example: Unknown operation to retrieve the GDAL supported formats.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"success or error",
            "example":"error"
        },
        "title":{
            "type":"string",
            "description":"Response description",
            "example":"Unknown operation to retrieve the GDAL supported formats."
        },
        "o:errorCode":{
            "type":"string",
            "description":"Error code.",
            "example":"SVR-E0018"
        },
        "detail":{
            "type":"string",
            "description":"Available raster operation parameters",
            "example":"Invalid parameters. Supported raster operations: load, process"
        }
    }
}

Back to Top

Examples

List the supported gdal formats for the passed raster process.

The following example shows how to get the supported GDAL formats for a raster process operation by submitting a GET request on the REST resource using cURL.

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

Example of Response Header

Example of Response Header

HTTP/1.1 200 OK Date: Wed, 22 Aug 2018 21:41:26 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" : "GDAL supported formats for operation type retrieved successfully.", "o:successCode" : "SVR-00209", "response" : { "items" : [ { "extensions" : [ "tif" ], "secondLoader" : true, "loader" : true, "bands" : [ ], "outputDataType" : null, "value" : "GTIFF", "inputOutputSrids" : null }, { "extensions" : [ "ntf" ], "secondLoader" : false, "loader" : true, "bands" : [ ], "outputDataType" : null, "value" : "NITF", "inputOutputSrids" : null }, { "extensions" : [ "img" ], "secondLoader" : false, "loader" : false, "bands" : [ ], "outputDataType" : null, "value" : "HFA", "inputOutputSrids" : null }, { "extensions" : [ "asc" ], "secondLoader" : false, "loader" : false, "bands" : [ 1 ], "outputDataType" : null, "value" : "AALGrid", "inputOutputSrids" : null }, { "extensions" : [ "grd" ], "secondLoader" : true, "loader" : true, "bands" : [ 1 ], "outputDataType" : null, "value" : "GSAG", "inputOutputSrids" : null }, { "extensions" : [ "dted" ], "secondLoader" : true, "loader" : true, "bands" : [ 1 ], "outputDataType" : null, "value" : "DTED", "inputOutputSrids" : null }, { "extensions" : [ "png" ], "secondLoader" : true, "loader" : true, "bands" : [ ], "outputDataType" : null, "value" : "PNG", "inputOutputSrids" : null }, { "extensions" : [ "jpg" ], "secondLoader" : true, "loader" : true, "bands" : [ ], "outputDataType" : null, "value" : "JPEG", "inputOutputSrids" : null }, { "extensions" : [ "gif" ], "secondLoader" : true, "loader" : true, "bands" : [ 1 ], "outputDataType" : null, "value" : "GIF", "inputOutputSrids" : null }, { "extensions" : [ "xpm" ], "secondLoader" : true, "loader" : true, "bands" : [ 1 ], "outputDataType" : null, "value" : "XPM", "inputOutputSrids" : null }, { "extensions" : [ "map" ], "secondLoader" : true, "loader" : true, "bands" : [ 1 ], "outputDataType" : null, "value" : "PCRASTER", "inputOutputSrids" : null }, { "extensions" : [ "mpr", "mpl" ], "secondLoader" : false, "loader" : true, "bands" : [ ], "outputDataType" : null, "value" : "ILWIS", "inputOutputSrids" : null }, { "extensions" : [ "fit" ], "secondLoader" : true, "loader" : true, "bands" : [ ], "outputDataType" : null, "value" : "FIT", "inputOutputSrids" : null }, { "extensions" : [ "rst" ], "secondLoader" : false, "loader" : false, "bands" : [ ], "outputDataType" : null, "value" : "RST", "inputOutputSrids" : null }, { "extensions" : [ "ingr" ], "secondLoader" : false, "loader" : false, "bands" : [ ], "outputDataType" : null, "value" : "INGR", "inputOutputSrids" : null }, { "extensions" : [ "grd" ], "secondLoader" : true, "loader" : true, "bands" : [ 1 ], "outputDataType" : null, "value" : "GSBG", "inputOutputSrids" : null }, { "extensions" : [ "grd" ], "secondLoader" : true, "loader" : true, "bands" : [ 1 ], "outputDataType" : null, "value" : "GS7BG", "inputOutputSrids" : null }, { "extensions" : [ "rda" ], "secondLoader" : true, "loader" : true, "bands" : [ ], "outputDataType" : null, "value" : "R", "inputOutputSrids" : null }, { "extensions" : [ null, "ehdr" ], "secondLoader" : false, "loader" : false, "bands" : [ ], "outputDataType" : null, "value" : "EHDR", "inputOutputSrids" : null }, { "extensions" : [ "hdr" ], "secondLoader" : false, "loader" : false, "bands" : [ ], "outputDataType" : null, "value" : "MFF", "inputOutputSrids" : null }, { "extensions" : [ "mff2", "/" ], "secondLoader" : false, "loader" : false, "bands" : [ ], "outputDataType" : null, "value" : "MFF2", "inputOutputSrids" : null }, { "extensions" : [ "arg" ], "secondLoader" : true, "loader" : true, "bands" : [ 1 ], "outputDataType" : null, "value" : "ARG", "inputOutputSrids" : null }, { "extensions" : [ "dem" ], "secondLoader" : false, "loader" : true, "bands" : [ 1 ], "outputDataType" : null, "value" : "USGSDEM", "inputOutputSrids" : null }, { "extensions" : [ "blx" ], "secondLoader" : false, "loader" : true, "bands" : [ 1 ], "outputDataType" : null, "value" : "BLX", "inputOutputSrids" : null }, { "extensions" : [ "sdat" ], "secondLoader" : false, "loader" : false, "bands" : [ 1 ], "outputDataType" : null, "value" : "SAGA", "inputOutputSrids" : null }, { "extensions" : [ "kmz" ], "secondLoader" : false, "loader" : false, "bands" : [ ], "outputDataType" : null, "value" : "KMLSUPEROVERLAY", "inputOutputSrids" : null }, { "extensions" : [ "xyz" ], "secondLoader" : false, "loader" : false, "bands" : [ 1 ], "outputDataType" : null, "value" : "XYZ", "inputOutputSrids" : null }, { "extensions" : [ "hf2" ], "secondLoader" : true, "loader" : true, "bands" : [ 1 ], "outputDataType" : null, "value" : "HF2", "inputOutputSrids" : null }, { "extensions" : [ "pdf" ], "secondLoader" : false, "loader" : false, "bands" : [ ], "outputDataType" : null, "value" : "PDF", "inputOutputSrids" : null }, { "extensions" : [ "dat" ], "secondLoader" : false, "loader" : false, "bands" : [ 1 ], "outputDataType" : null, "value" : "ZMAP", "inputOutputSrids" : null } ] } }

Back to Top