Big Data Spatial and GraphのREST API

ラスター操作でサポートされているgdal形式の取得

get

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

リクエスト

パス・パラメータ

rasterOperation: string

ラスター操作名(処理、ロード)

先頭に戻る

レスポンス

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

application/json

200レスポンス

要求が成功しました

ルート・スキーマ: RasterGdalFormatsSuccessResponse

型: object

ソースの表示

o:successCode(optional): string

成功コード。

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

詳細な形式を含むレスポンスの詳細情報
status(optional): string

成功またはエラー

例: sucess
title(optional): string

レスポンスの説明

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

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

型: object

詳細な形式を含むレスポンスの詳細情報

ソースの表示

items(optional): array items

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

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

型: array

ソースの表示

配列: object RasterGdalFormatDetails

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

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

型: object

ソースの表示

bands(optional): array bands
extensions: array extensions
inputOutputSrids(optional): object inputOutputSrids

ラスター操作でこの形式を選択した後、入力SRIDおよび出力SRIDの詳細を持つオブジェクト。オブジェクト・キーは動的な値です。
loader: boolean

この書式がラスター・ローダーAPIと互換性があるかどうかを判断します。

例: true
outputDataType(optional): number

ラスター操作でこの形式を選択した後、出力の最終的なデータ型を示します。

例: 64
secondLoader: boolean

ラスター処理後にこの形式をhdfsにアップロードできるかどうかを決定します。

例: true
value: string

形式の一般名

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

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

型: array

ソースの表示

配列: number

形式に関するバンド制限を指定します

例: [ 1 ]

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

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

型: array

ソースの表示

配列: string

ラスター操作でこの形式を選択した後、出力形式の拡張を詳しく説明します。'/'は、この形式によって単一ファイルではなくフォルダに出力されることを示すワイルドカードとして使用されます。

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

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

型: object

ラスター操作でこの形式を選択した後、入力SRIDおよび出力SRIDの詳細を持つオブジェクト。オブジェクト・キーは動的な値です。

例:

{
    "26904":4269
}

400レスポンス

ラスター操作リクエストが無効です

ルート・スキーマ: RasterGdalFormatsInvalidOperationResponse

型: object

ソースの表示

detail(optional): string

使用可能なラスター操作のパラメータ

例: Invalid parameters. Supported raster operations: load, process
o:errorCode(optional): string

エラー・コード。

例: SVR-E0018
status(optional): string

成功またはエラー

例: error
title(optional): string

レスポンスの説明

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

先頭に戻る

例

渡されたラスター処理でサポートされているgdal形式を一覧表示します。

次の例は、cURLを使用してRESTリソースに対するGET要求を発行することによって、ラスター処理操作でサポートされているGDAL形式を取得する方法を示しています。

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

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

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

レスポンス本文の例

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

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

先頭に戻る