Big Data Spatial and GraphのREST API

サーバー内のカスタムjarの詳細の取得

get

/spatialviewer/api/v1/raster/userCustomJar

リクエスト

この操作のリクエスト・パラメータはありません。

先頭に戻る

レスポンス

サポートされるメディア・タイプ

application/json

200レスポンス

要求が成功しました

ルート・スキーマ: RasterUserCustomJarSuccessResponse

型: object

ソースの表示

o:successCode(optional): string

成功コード。

例: SVR-00201
response(optional): object response

レスポンスの詳細情報
status(optional): string

成功またはエラー

例: success
title(optional): string

レスポンスの説明

例: 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"
                    ]
                }
            }
        }
    }
}

ネストされたスキーマ: response

型: object

レスポンスの詳細情報

ソースの表示

items(optional):

例: [ "oracle.spatial.raster.HillShade", "oracle.spatial.hadoop.imageprocessor.process.ImageSlope" ]
value(optional): string

jarファイル名

例: 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レスポンス

ユーザー・カスタムjarファイルが見つかりませんでした。ラスターAPI内の実装クラスは、見つかった場合は返されます。

ルート・スキーマ: RasterUserCustomJarNotFoundResponse

型: object

ソースの表示

o:successCode(optional): string

成功コード。

例: SVR-E0004
response(optional): object response

レスポンスの詳細情報
status(optional): string

成功またはエラー

例: success
title(optional): string

レスポンスの説明

例: 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"
                    ]
                }
            }
        }
    }
}

ネストされたスキーマ: response

型: object

レスポンスの詳細情報

ソースの表示

items(optional):

例: [ "oracle.spatial.hadoop.imageprocessor.process.ImageSlope" ]

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

先頭に戻る

例

以前にサーバーにアップロードしたカスタムjarの名前を取得します。また、ユーザーがカスタム・コードを作成できるインタフェースを実装するすべてのクラスが戻されます。

次の例では、cURLを使用してRESTリソースに対するGETリクエストを発行することで、以前にアップロードしたカスタムjarファイルの名前および実装クラスのリストを取得する方法を示しています。

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

レスポンス・ヘッダーの例

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

レスポンス本文の例

次の例は、レスポンス本文の内容をJSON形式で示したものです

{ "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" ] }}

先頭に戻る