运行模型 - kqmicrogo

请求参数

Header 参数

ua_token

string

可选

默认值:

Body 参数application/json

request

string

请求方法

可选

默认值:

runModel

正则匹配:

runModel

asyn

boolean

必需

是否异步运行，默认为false，同步阻塞执行；异步执行则为在独立线程执行，返回任务id，后续可通过获取任务状态获取结果信息，对于需长时间运行的模型建议异步方式。

默认值:

false

model

object (model)

必需

地理模型或者地理算子工具

params

array[object (paramVar) {13}]

独立参数变量信息

可选

processes

array[object (process) {4}]

必需

地理处理工具算子的信息，可以存在多个算子串联

connect

array[object (connect) {3}]

可选

每个算子之间的连接信息，算子间输出参数和输入参数之间的连接信息

buildType

enum<integer>

可选

返回结果参数组织方式，默认为1,1 代表参数按照paramID：value 组织；0，代表按照数组组织：paramID：值，value：值

枚举值:

layout

object

可选

GP模型的ui布局，保留，暂时未使用。

示例

{
    "model":{
        "processes":[
            {
                "id":"c96e14f2_c16558",
                "toolboxid":"SystemToolboxs:Hydrology",
                "toolid":"KQGPToolRaster:KQGPToolFill",
                "params":{
                    "_Input Raster":"{\"CONNECTTYPE\":\"Folder\",\"DATASET_TYPE\":2,\"FILEPATH\":\"D:/KQGIS/data/DEM\",\"DATASET_NAME\":\"算堰塞湖的.tif\"}",
                    "_Z Value":11
                }
            },
            {
                "id":"c709825f_2c751",
                "toolboxid":"SystemToolboxs:Hydrology",
                "toolid":"KQGPToolRaster:KQGPToolFlowDirection",
                "params":{

                }
            },
            {
                "id":"5a390437_10107c",
                "toolboxid":"SystemToolboxs:Hydrology",
                "toolid":"KQGPToolRaster:KQGPToolFlows",
                "params":{
                    "_Pix Data Type":"{\"currentIndex\":\"5\",\"isEditable\":false,\"value\":[\"Byte\",\"UInt16\",\"Int16\",\"UInt32\",\"Int32\",\"Float32\",\"Float64\"]}"
                }
            },
            {
                "id":"2f821932_856a36",
                "toolboxid":"SystemToolboxs:Hydrology",
                "toolid":"KQGPToolRaster:KQGPToolCreateStream",
                "params":{
                    "_Threshold Value":33,
                    "_Pix Data Type":"{\"currentIndex\":\"5\",\"isEditable\":false,\"value\":[\"Byte\",\"UInt16\",\"Int16\",\"UInt32\",\"Int32\",\"Float32\",\"Float64\"]}"
                }
            }
        ],
        "connect":[
            {
                "connectionType":"parameter",
                "from":{
                    "elementId":"",
                    "name":"Output Raster Dataset File",
                    "id":"c96e14f2_c16558"
                },
                "to":{
                    "elementId":"",
                    "name":"Input Raster",
                    "id":"c709825f_2c751"
                }
            },
            {
                "connectionType":"parameter",
                "from":{
                    "elementId":"",
                    "name":"Output Raster Dataset File",
                    "id":"c709825f_2c751"
                },
                "to":{
                    "elementId":"",
                    "name":"Direction Raster",
                    "id":"5a390437_10107c"
                }
            },
            {
                "connectionType":"parameter",
                "from":{
                    "elementId":"",
                    "name":"Output Raster Dataset File",
                    "id":"5a390437_10107c"
                },
                "to":{
                    "elementId":"",
                    "name":"Flows Raster",
                    "id":"2f821932_856a36"
                }
            }
        ],
        "layout":{

        }
    },
    "asyn":false,
    "request":"GeoProcessingService",
    "command":"runModel"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://172.16.1.44:9800/rest/services/common/geoprocessing/runmodel' \
--header 'ua_token: ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "model":{
        "processes":[
            {
                "id":"c96e14f2_c16558",
                "toolboxid":"SystemToolboxs:Hydrology",
                "toolid":"KQGPToolRaster:KQGPToolFill",
                "params":{
                    "_Input Raster":"{\"CONNECTTYPE\":\"Folder\",\"DATASET_TYPE\":2,\"FILEPATH\":\"D:/KQGIS/data/DEM\",\"DATASET_NAME\":\"算堰塞湖的.tif\"}",
                    "_Z Value":11
                }
            },
            {
                "id":"c709825f_2c751",
                "toolboxid":"SystemToolboxs:Hydrology",
                "toolid":"KQGPToolRaster:KQGPToolFlowDirection",
                "params":{

                }
            },
            {
                "id":"5a390437_10107c",
                "toolboxid":"SystemToolboxs:Hydrology",
                "toolid":"KQGPToolRaster:KQGPToolFlows",
                "params":{
                    "_Pix Data Type":"{\"currentIndex\":\"5\",\"isEditable\":false,\"value\":[\"Byte\",\"UInt16\",\"Int16\",\"UInt32\",\"Int32\",\"Float32\",\"Float64\"]}"
                }
            },
            {
                "id":"2f821932_856a36",
                "toolboxid":"SystemToolboxs:Hydrology",
                "toolid":"KQGPToolRaster:KQGPToolCreateStream",
                "params":{
                    "_Threshold Value":33,
                    "_Pix Data Type":"{\"currentIndex\":\"5\",\"isEditable\":false,\"value\":[\"Byte\",\"UInt16\",\"Int16\",\"UInt32\",\"Int32\",\"Float32\",\"Float64\"]}"
                }
            }
        ],
        "connect":[
            {
                "connectionType":"parameter",
                "from":{
                    "elementId":"",
                    "name":"Output Raster Dataset File",
                    "id":"c96e14f2_c16558"
                },
                "to":{
                    "elementId":"",
                    "name":"Input Raster",
                    "id":"c709825f_2c751"
                }
            },
            {
                "connectionType":"parameter",
                "from":{
                    "elementId":"",
                    "name":"Output Raster Dataset File",
                    "id":"c709825f_2c751"
                },
                "to":{
                    "elementId":"",
                    "name":"Direction Raster",
                    "id":"5a390437_10107c"
                }
            },
            {
                "connectionType":"parameter",
                "from":{
                    "elementId":"",
                    "name":"Output Raster Dataset File",
                    "id":"5a390437_10107c"
                },
                "to":{
                    "elementId":"",
                    "name":"Flows Raster",
                    "id":"2f821932_856a36"
                }
            }
        ],
        "layout":{

        }
    },
    "asyn":false,
    "request":"GeoProcessingService",
    "command":"runModel"
}'

返回响应

🟢200成功

application/json

Body

result

object

必需

5c3c9b22_96dd84

array [object {4}]

必需

a4260d69_26b28

array [object {4}]

必需

b1230d69_48b55

array [object {4}]

必需

resultcode

string

必需

taskID

string

必需

示例

{
    "result": {
        "5c3c9b22_96dd84": [
            {
                "elementID": "",
                "instanceID": "{94ecd09a-8ff7-4b9c-840f-4435394722b9}",
                "name": "Output number",
                "value": 48
            }
        ],
        "a4260d69_26b28": [
            {
                "elementID": "",
                "instanceID": "{c16fea6e-8693-437b-bd32-a6d222ee2e7e}",
                "name": "Output number",
                "value": 10
            }
        ],
        "b1230d69_48b55": [
            {
                "elementID": "",
                "instanceID": "{dd41fbc7-eab2-4247-8f18-c0db0c271366}",
                "name": "Output number",
                "value": 38
            }
        ]
    },
    "resultcode": "success",
    "taskID": "gp_{5e071cff-68f2-4c7d-ad06-2f42514e68a0}"
}