Jump to

• Request
• Response
• Examples

Loads raster files into HDFS using hadoop as implementation

post

/spatialviewer/api/v1/raster/hadoop/operations/load

Request

Supported Media Types

• application/json

Query Parameters

• async(optional): boolean
  Indicates if the job requires to be executed asynchronous or not. By default this value is false.

Body ()

Raster load object with all the required details

Root Schema : RasterLoadOperationPayloadObject

Type: object

Show Source

• dfsBlockSizeMB: number
  Value used to determine the tiles size of the upload rasters.

  Example: 128
• inputPaths: string
  File paths separed by comma

  Example: /opt/oracle/oracle-spatial-graph/spatial/raster/HOL/data/raster/hawaii.tif,/opt/oracle/oracle-spatial-graph/spatial/raster/HOL/data/raster/maui.tif
• memoryMB(optional): number
  Value used to reserve memory for run the job in hadoop. If you send this value to the spark endpoint the value will be ignored.

  Example: 160
• outputDirectory: string
  Output directory name. Directory will be created inside the HDFS (If it not exists yet). By default: upload. It follow the rules for directory names, special characters are not valid even ':'

  Example: upload
• overlap: number
  Minimum Value: 1

  Maximum Value: 200

  Raster overlap value

  Example: 2

{
    "type":"object",
    "properties":{
        "overlap":{
            "type":"number",
            "description":"Raster overlap value",
            "example":2,
            "minimum":1,
            "maximum":200
        },
        "inputPaths":{
            "type":"string",
            "description":"File paths separed by comma",
            "example":"/opt/oracle/oracle-spatial-graph/spatial/raster/HOL/data/raster/hawaii.tif,/opt/oracle/oracle-spatial-graph/spatial/raster/HOL/data/raster/maui.tif"
        },
        "outputDirectory":{
            "type":"string",
            "description":"Output directory name. Directory will be created inside the HDFS (If it not exists yet). By default: upload. It follow the rules for directory names, special characters are not valid even ':'",
            "example":"upload"
        },
        "memoryMB":{
            "type":"number",
            "description":"Value used to reserve memory for run the job in hadoop. If you send this value to the spark endpoint the value will be ignored.",
            "example":160
        },
        "dfsBlockSizeMB":{
            "type":"number",
            "description":"Value used to determine the tiles size of the upload rasters.",
            "example":128
        }
    },
    "required":[
        "outputDirectory",
        "overlap",
        "inputPaths",
        "dfsBlockSizeMB"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

raster load operation has been done successfully

Body ()

Root Schema : RasterLoadOperationSuccessResponse

Type: object

Show Source

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

  Example: SVR-00200
• response(optional): object response
  Details about the success response
• status(optional): string
  success or error

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

  Example: Success Response.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"success or error",
            "example":"sucess"
        },
        "title":{
            "type":"string",
            "description":"Response description",
            "example":"Success Response."
        },
        "o:successCode":{
            "type":"string",
            "description":"Success code.",
            "example":"SVR-00200"
        },
        "response":{
            "type":"object",
            "description":"Details about the success response",
            "properties":{
                "message":{
                    "type":"string",
                    "description":"Success message",
                    "example":"Rasters load finished successfully, jobId: job_1533232152884_0462"
                },
                "items":{
                    "type":"array",
                    "description":"List the details of the uploaded rasters individually.",
                    "items":{
                        "$ref":"#/definitions/RasterLoadRasterDetailsEntry"
                    }
                }
            }
        }
    }
}

Nested Schema : response

Type: object

Details about the success response

Show Source

• items(optional): array items
  List the details of the uploaded rasters individually.
• message(optional): string
  Success message

  Example: Rasters load finished successfully, jobId: job_1533232152884_0462

{
    "type":"object",
    "description":"Details about the success response",
    "properties":{
        "message":{
            "type":"string",
            "description":"Success message",
            "example":"Rasters load finished successfully, jobId: job_1533232152884_0462"
        },
        "items":{
            "type":"array",
            "description":"List the details of the uploaded rasters individually.",
            "items":{
                "$ref":"#/definitions/RasterLoadRasterDetailsEntry"
            }
        }
    }
}

Nested Schema : items

Type: array

List the details of the uploaded rasters individually.

Show Source

• Array of: object RasterLoadRasterDetailsEntry

{
    "type":"array",
    "description":"List the details of the uploaded rasters individually.",
    "items":{
        "$ref":"#/definitions/RasterLoadRasterDetailsEntry"
    }
}

Nested Schema : RasterLoadRasterDetailsEntry

Type: object

Show Source

• inputFile(optional): string
  Input file path.

  Example: /net/den01spo/scratch/swap/spatialviewer/data/rasters/kahoolawe.tif
• metadata(optional): string
  Path of the generated raster metadata.

  Example: /user/hdfs/spatial_raster/metadata/af766de6bf3ea93700163ee99ca6d61c88501ae6.loc
• outputFile(optional): string
  Path of the uploaded raster in a special format.

  Example: /user/hdfs/upload/kahoolawe.tif.ohif
• thumbnail(optional): string
  Path of the generated thumbnail for this raster file.

  Example: /net/den01spo/scratch/swap/spatialviewer//thumb/user/hdfs/upload/kahoolawe.tif.ohif.tif

{
    "type":"object",
    "properties":{
        "inputFile":{
            "type":"string",
            "description":"Input file path.",
            "example":"/net/den01spo/scratch/swap/spatialviewer/data/rasters/kahoolawe.tif"
        },
        "metadata":{
            "type":"string",
            "description":"Path of the generated raster metadata.",
            "example":"/user/hdfs/spatial_raster/metadata/af766de6bf3ea93700163ee99ca6d61c88501ae6.loc"
        },
        "outputFile":{
            "type":"string",
            "description":"Path of the uploaded raster in a special format.",
            "example":"/user/hdfs/upload/kahoolawe.tif.ohif"
        },
        "thumbnail":{
            "type":"string",
            "description":"Path of the generated thumbnail for this raster file.",
            "example":"/net/den01spo/scratch/swap/spatialviewer//thumb/user/hdfs/upload/kahoolawe.tif.ohif.tif"
        }
    }
}

202 Response

raster load operations was schedule

Body ()

Root Schema : RasterOperationAcceptedResponse

Type: object

Show Source

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

  Example: SVR-00205
• response(optional): string
  Job status tracking URL

  Example: http://system4.example.com:8088
• status(optional): string
  success or error

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

  Example: Job was accepted.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"success or error",
            "example":"sucess"
        },
        "title":{
            "type":"string",
            "description":"Response description",
            "example":"Job was accepted."
        },
        "o:successCode":{
            "type":"string",
            "description":"Success code.",
            "example":"SVR-00205"
        },
        "response":{
            "type":"string",
            "description":"Job status tracking URL",
            "example":"http://system4.example.com:8088"
        }
    }
}

406 Response

invalid parameters

Body ()

Root Schema : RasterOperationsInvalidParametersResponse

Type: object

Show Source

• detail(optional): string
  Response details information message about the bad parameters

  Example: newDiretory: New Directory name can not be null, overlap: Overlap value can not be null
• o:errorCode(optional): string
  Error code.

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

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

  Example: Invalid parameters.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"success or error",
            "example":"error"
        },
        "title":{
            "type":"string",
            "description":"Response description",
            "example":"Invalid parameters."
        },
        "o:errorCode":{
            "type":"string",
            "description":"Error code.",
            "example":"SVR-E0010"
        },
        "detail":{
            "type":"string",
            "description":"Response details information message about the bad parameters",
            "example":"newDiretory: New Directory name can not be null, overlap: Overlap value can not be null"
        }
    }
}

417 Response

raster load operation has been done unsuccessfully due some error in the choose implementation

Body ()

Root Schema : RasterLoadOperationUnsuccessResponse

Type: object

Show Source

• detail(optional): string
  Response details information message about the failed job. For hadoop can contain information about the logs like an URL to download the log details.

  Example: Raster load finished unsuccessfully
• o:errorCode(optional): string
  Error code.

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

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

  Example: Invalid parameters.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"success or error",
            "example":"error"
        },
        "title":{
            "type":"string",
            "description":"Response description",
            "example":"Invalid parameters."
        },
        "o:errorCode":{
            "type":"string",
            "description":"Error code.",
            "example":"SVR-E0020"
        },
        "detail":{
            "type":"string",
            "description":"Response details information message about the failed job. For hadoop can contain information about the logs like an URL to download the log details.",
            "example":"Raster load finished unsuccessfully"
        }
    }
}

500 Response

unknow error

Body ()

Root Schema : RasterErrorGenericResponse

Type: object

Show Source

• detail(optional): string
  Response details information

  Example: Unknow error
• o:errorCode(optional): string
  Success code.

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

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

  Example: Error while processing REST request.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"success or error",
            "example":"error"
        },
        "title":{
            "type":"string",
            "description":"Response description",
            "example":"Error while processing REST request."
        },
        "o:errorCode":{
            "type":"string",
            "description":"Success code.",
            "example":"SVR-E0001"
        },
        "detail":{
            "type":"string",
            "description":"Response details information",
            "example":"Unknow error"
        }
    }
}

503 Response

GDAL set up is incomplete

Body ()

Root Schema : GDALSetUpIsIncompleteResponse

Type: object

Show Source

• detail(optional): string
  Informative message

  Example: GDAL library is not correctly set up. Check the admin settings or your GDAL installation
• o:errorCode(optional): string
  Error code.

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

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

  Example: GDAL library is not correctly set up.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"success or error",
            "example":"error"
        },
        "title":{
            "type":"string",
            "description":"Response description",
            "example":"GDAL library is not correctly set up."
        },
        "o:errorCode":{
            "type":"string",
            "description":"Error code.",
            "example":"SVR-E0012"
        },
        "detail":{
            "type":"string",
            "description":"Informative message",
            "example":"GDAL library is not correctly set up. Check the admin settings or your GDAL installation"
        }
    }
}

Back to Top

Examples

Schedules or initiates a load job using hadoop to load the raster files into hdfs.

The following example shows how to submit a raster load using hadoop as implementation by submitting a POST request on the REST resource using cURL.

curl -X POST "http://localhost:8045/spatialviewer/api/v1/raster/hadoop/operations/load?async=false" -H "accept: application/json" -H "Content-Type: application/json" -d "{\"outputDirectory\":\"upload\",\"overlap\":\"2\",\"blockSizeMB (MB)\":\"128\",\"inputPaths\":\"/net/den01spo/scratch/swap/spatialviewer/data/rasters/hawaii.tif,/net/den01spo/scratch/swap/spatialviewer/data/rasters/kahoolawe.tif\"}"

Example of Response Header

Example of Response Header

HTTP/1.1 200 OK Date: Wed, 22 Aug 2018 22:22:14 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" : "Success Response.", "o:successCode" : "SVR-00200", "response" : { "message" : "Rasters load finished successfully, jobId: job_1533232152884_0599", "items" : [ { "inputFile" : "/net/den01spo/scratch/swap/spatialviewer/data/rasters/hawaii.tif", "metadata" : "/user/hdfs/spatial_raster/metadata/17ab9d9595ee7e85a90f5410d1c99fb77c71f033.loc", "outputFile" : "/user/hdfs/upload/net/den01spo/scratch/swap/spatialviewer/data/rasters/hawaii.tif.ohif", "thumbnail" : "/net/den01spo/scratch/swap/spatialviewer//thumb/user/hdfs/upload/net/den01spo/scratch/swap/spatialviewer/data/rasters/hawaii.tif.ohif.tif" }, { "inputFile" : "/net/den01spo/scratch/swap/spatialviewer/data/rasters/kahoolawe.tif", "metadata" : "/user/hdfs/spatial_raster/metadata/25a071b7e5cb943a75c90b2ddc00cbc3666f083e.loc", "outputFile" : "/user/hdfs/upload/net/den01spo/scratch/swap/spatialviewer/data/rasters/kahoolawe.tif.ohif", "thumbnail" : "/net/den01spo/scratch/swap/spatialviewer//thumb/user/hdfs/upload/net/den01spo/scratch/swap/spatialviewer/data/rasters/kahoolawe.tif.ohif.tif" } ] } }

Back to Top