Jump to

• Request
• Response
• Examples

Retrieves the details of the custom jar in the server

get

/spatialviewer/api/v1/raster/userCustomJar

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

successful request

Body ()

Root Schema : RasterUserCustomJarSuccessResponse

Type: object

Show Source

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

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

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

  Example: Uploaded custom jar file was found.

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

Nested Schema : response

Type: object

Response details

Show Source

• items(optional):
  Example: [ "oracle.spatial.raster.HillShade", "oracle.spatial.hadoop.imageprocessor.process.ImageSlope" ]
• 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":{
            "example":[
                "oracle.spatial.raster.HillShade",
                "oracle.spatial.hadoop.imageprocessor.process.ImageSlope"
            ]
        }
    }
}

206 Response

User custom jar file was not found. Implementation classes in the raster API are return if found.

Body ()

Root Schema : RasterUserCustomJarNotFoundResponse

Type: object

Show Source

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

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

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

  Example: User custom jar file can not be found.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"success or error",
            "example":"success"
        },
        "title":{
            "type":"string",
            "description":"Response description",
            "example":"User custom jar file can not be found."
        },
        "o:successCode":{
            "type":"string",
            "description":"Success code.",
            "example":"SVR-E0004"
        },
        "response":{
            "type":"object",
            "description":"Response details",
            "properties":{
                "items":{
                    "example":[
                        "oracle.spatial.hadoop.imageprocessor.process.ImageSlope"
                    ]
                }
            }
        }
    }
}

Nested Schema : response

Type: object

Response details

Show Source

• items(optional):
  Example: [ "oracle.spatial.hadoop.imageprocessor.process.ImageSlope" ]

{
    "type":"object",
    "description":"Response details",
    "properties":{
        "items":{
            "example":[
                "oracle.spatial.hadoop.imageprocessor.process.ImageSlope"
            ]
        }
    }
}

Back to Top

Examples

Retrieves the name of the custom jar that was previous upload to the server. Also returns all the classes that implements the interface that enable the user create his custom code.

The following example shows how to get the name of the previously upload custom jar file, and a list of the implementation classes by submitting a GET request on the REST resource using cURL.

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

Example of Response Header

Example of Response Header

HTTP/1.1 200 OK Date: Tue, 21 Aug 2018 23:16:46 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" : "Uploaded custom jar file was found.", "o:successCode" : "SVR-00201", "response" : { "value" : "external-analysis.jar", "items" : [ "oracle.spatial.raster.HillShade", "oracle.spatial.hadoop.imageprocessor.process.ImageSlope" ] }}

Back to Top