Jump to

• Request
• Response
• Examples

Uploads a user custom jar file to the server.

post

/spatialviewer/api/v1/raster/userCustomJar

Request

Supported Media Types

• multipart/form-data

Form Parameters

• file: file
  User implementation file (.jar)

Back to Top

Response

Supported Media Types

• application/json

200 Response

successful request

Body ()

Root Schema : RasterUploadUserCustomJarSucess

Type: object

Show Source

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

  Example: SVR-00202
• response(optional): object response
  Response details
• status(optional): string
  success or error

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

  Example: Custom jar file was upload correctly.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"success or error",
            "example":"success"
        },
        "title":{
            "type":"string",
            "description":"Response description",
            "example":"Custom jar file was upload correctly."
        },
        "o:successCode":{
            "type":"string",
            "description":"Success code.",
            "example":"SVR-00202"
        },
        "response":{
            "type":"object",
            "description":"Response details",
            "properties":{
                "value":{
                    "type":"string",
                    "description":"Jar file name",
                    "example":"external-analysis.jar"
                },
                "items":{
                    "type":"array",
                    "items":{
                        "type":"string",
                        "example":[
                            "oracle.spatial.raster.HillShade",
                            "oracle.spatial.hadoop.imageprocessor.process.ImageSlope"
                        ]
                    }
                }
            }
        }
    }
}

Nested Schema : response

Type: object

Response details

Show Source

• items(optional): array items
• value(optional): string
  Jar file name

  Example: external-analysis.jar

{
    "type":"object",
    "description":"Response details",
    "properties":{
        "value":{
            "type":"string",
            "description":"Jar file name",
            "example":"external-analysis.jar"
        },
        "items":{
            "type":"array",
            "items":{
                "type":"string",
                "example":[
                    "oracle.spatial.raster.HillShade",
                    "oracle.spatial.hadoop.imageprocessor.process.ImageSlope"
                ]
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: string
  Example: [ "oracle.spatial.raster.HillShade", "oracle.spatial.hadoop.imageprocessor.process.ImageSlope" ]

{
    "type":"array",
    "items":{
        "type":"string",
        "example":[
            "oracle.spatial.raster.HillShade",
            "oracle.spatial.hadoop.imageprocessor.process.ImageSlope"
        ]
    }
}

406 Response

File details are no correct.

Body ()

Root Schema : RasterUploadUserCustomJarNotAcceptable

Type: object

Show Source

• detail(optional): string
  Error response detail text

  Example: Must supply a file or a jar file
• o:errorCode(optional): string
  Error code.

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

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

  Example: File upload can not be null or must be a jar file.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"success or error",
            "example":"error"
        },
        "title":{
            "type":"string",
            "description":"Response description",
            "example":"File upload can not be null or must be a jar file."
        },
        "o:errorCode":{
            "type":"string",
            "description":"Error code.",
            "example":"SVR-E0005"
        },
        "detail":{
            "type":"string",
            "description":"Error response detail text",
            "example":"Must supply a file or a jar file"
        }
    }
}

Back to Top

Examples

Allows the user to upload a custom jar with his own implementations for the raster process.

The following example shows how to upload an user cumstom jar file by submitting a POST request on the REST resource using cURL.

curl -X POST "http://localhost:8045/spatialviewer/api/v1/raster/userCustomJar" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "file=@/opt/oracle/oracle-spatial-graph/spatial/raster/Raster-HOL/jlib/external-analysis.jar"

Example of Response Header

Example of Response Header

HTTP/1.1 100 Continue HTTP/1.1 200 OK Date: Wed, 22 Aug 2018 19:35:57 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" : "Custom jar file was upload correctly.","o:successCode" : "SVR-00202","response" : {"value" : "external-analysis.jar","items" : [ "oracle.spatial.raster.HillShade", "oracle.spatial.hadoop.imageprocessor.process.ImageSlope" ]}}

Back to Top