运行地理处理模型(runModel)

运行地理处理模型

数组方式组织

{
    "asyn": false,
   "name":"任务名称",
    "extension":"userName:jjjkk",
    "userId":"id-kdkdkl",
	"params": [
		{
			"paramId": "_Input Raster",
			"value": "{\"dataset\":\"{\\\"CONNECTTYPE\\\":\\\"Folder\\\",\\\"DATASET_ALIAS\\\":\\\"线转删格.img\\\",\\\"DATASET_NAME\\\":\\\"线转删格.img\\\",\\\"DATASET_TYPE\\\":2,\\\"FILEPATH\\\":\\\"D:\/Server_V8.5_SDK_AutoTests\/测试数据\/地理处理服务\/线转删格.img\\\"}\",\"fileSuffixList\":[],\"isButtonVisible\":true,\"isSave\":false,\"save_connectionInfo\":\"\",\"save_datasetName\":\"\",\"save_parentDatasetName\":\"\"}"
		},
		{
			"paramId": "_Field name",
			"value": "{\"value\":\"DN\"}"
		},
		{
			"paramId": "_Output Shp File",
			"value": "{\"fileDir\":\"\",\"isEditable\":true,\"isSave\":true,\"suffix\":\"Shapefile(*.shp)\",\"value\":\"D:\/Server_V8.5_SDK_AutoTests\/测试结果\/地理处理服务\/栅格转线.shp\"}"
		}
	],
	"tool": "KQGPToolRaster:KQGPToolRasterToLine"
}

对象方式组织参数

{ "asyn": false, "name":"任务名称", "userId":"id-kdkdkl", "extension":"userName:jjjkk", "tool": "KQGPToolRasterToLine", "params": { "_Output Shp File": "{\"fileDir\":\"\",\"isEditable\":true,\"isSave\":true,\"suffix\":\"Shapefile(*.shp)\",\"value\":\"D:\/Server_V8.5_SDK_AutoTests\/测试结果\/地理处理服务\/栅格转线.shp\"}", "_Field name": "{\"value\":\"DN\"}", "_Input Raster": "{\"dataset\":\"{\\\"CONNECTTYPE\\\":\\\"Folder\\\",\\\"DATASET_ALIAS\\\":\\\"线转删格.img\\\",\\\"DATASET_NAME\\\":\\\"线转删格.img\\\",\\\"DATASET_TYPE\\\":2,\\\"FILEPATH\\\":\\\"D:\/Server_V8.5_SDK_AutoTests\/测试数据\/地理处理服务\/线转删格.img\\\"}\",\"fileSuffixList\":[],\"isButtonVisible\":true,\"isSave\":false,\"save_connectionInfo\":\"\",\"save_datasetName\":\"\",\"save_parentDatasetName\":\"\"}" }

}

单个工具算子请求

{

"tool": "KQGPToolRaster:KQGPToolRasterToLine",
"params": {
"_Field name": "{"value":"DN"}",
"_Input Raster": "{"dataset":"{\"CONNECTTYPE\":\"Folder\",\"DATASET_ALIAS\":\"线转删格.img\",\"DATASET_NAME\":\"线转删格.img\",\"DATASET_TYPE\":2,\"FILEPATH\":\"D:/Server_V8.5_SDK_AutoTests/测试数据/地理处理服务/线转删格.img\"}","fileSuffixList":[],"isButtonVisible":true,"isSave":false,"save_connectionInfo":"","save_datasetName":"","save_parentDatasetName":""}",
"_Output Shp File": "{"fileDir":"","isEditable":true,"isSave":true,"suffix":"Shapefile(*.shp)","value":"D:/Server_V8.5_SDK_AutoTests/测试结果/地理处理服务/栅格转线.shp"}"
},
"asyn": false,
"name":"任务名称",
"extension":"userName:jjjkk",
"userId":"id-kdkdkl"
}

分布式算子运行

{
	"tool":"KQGPToolRasterToLine",
	"distributed":true,
	"params":{
		"_ServerUrl":"{\"paramBase\":{\"height\":0,\"isConnectParam\":false,\"isEnable\":true,\"isRequest\":true,\"isVisible\":true,\"isVisibleDisplayName\":true,\"width\":0},\"value\":\"http://172.4.2.228:8299/taskmanager\"}",
		"_MetaFile":"{\"fileDir\":\"\",\"isEditable\":true,\"isSave\":false,\"paramBase\":{\"height\":0,\"isConnectParam\":false,\"isEnable\":true,\"isRequest\":true,\"isVisible\":true,\"isVisibleDisplayName\":true,\"width\":0},\"suffix\":\"*.xml\",\"value\":\"D:/source/KQGIS/32suo/01测试数据/倾斜摄影/metadata.xml\"}",
		"_DataFolder":"{\"filePath\":\"D:/source/KQGIS/32suo/01测试数据/倾斜摄影/Data\",\"fileSuffixList\":[],\"isEditable\":true,\"paramBase\":{\"height\":0,\"isConnectParam\":false,\"isEnable\":true,\"isRequest\":true,\"isVisible\":true,\"isVisibleDisplayName\":true,\"width\":0}}",
		"_TextureType":"{\"list\":[{\"paramBase\":{\"height\":0,\"isConnectParam\":false,\"isEnable\":true,\"isRequest\":true,\"isVisible\":true,\"isVisibleDisplayName\":true,\"width\":0},\"value\":\"true\"},{\"paramBase\":{\"height\":0,\"isConnectParam\":false,\"isEnable\":true,\"isRequest\":true,\"isVisible\":true,\"isVisibleDisplayName\":true,\"width\":0},\"value\":\"false\"}],\"paramBase\":{\"height\":0,\"isConnectParam\":false,\"isEnable\":true,\"isRequest\":false,\"isVisible\":true,\"isVisibleDisplayName\":true,\"width\":0},\"type\":0}",
		"_OutFolder":"{\"filePath\":\"D:/source/KQGIS/32suo/11\",\"fileSuffixList\":[],\"isEditable\":true,\"paramBase\":{\"height\":0,\"isConnectParam\":false,\"isEnable\":true,\"isRequest\":true,\"isVisible\":true,\"isVisibleDisplayName\":true,\"width\":0}}",
		"_OutputJsonName":"{\"paramBase\":{\"height\":0,\"isConnectParam\":false,\"isEnable\":true,\"isRequest\":true,\"isVisible\":true,\"isVisibleDisplayName\":true,\"width\":0},\"value\":\"tileset\"}",
		"_MaxRootCount":"{\"lower\":\"-128\",\"number\":{\"isNull\":false,\"paramBase\":{\"height\":0,\"isConnectParam\":false,\"isEnable\":true,\"isRequest\":true,\"isVisible\":true,\"isVisibleDisplayName\":true,\"width\":0},\"paramUIType\":1},\"upper\":\"127\",\"value\":\"0\"}",
		"_NodeCount":"3",
		"_ThreadCountPerNode":"3"
	},
    "asyn":true
}

请求参数

Body 参数application/json

asyn

string

必需

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

params

object

可选

参数信息，内容的数量可变，依赖具体算子的参数数量，json数组，每个数组项参考param 说明

elementId

string

可选

参数所属gptool 元素id

name

string

参数名称

可选

paramId

string

必需

参数id，优先使用该值，如果没有则使用elementId + name

value

string

必需

参数值字符串类型，布尔、数值、字符串类型直接传值，其他参数类型以字符串传值，对字符串格式有严格要求，参考一下参数类型传值格式规范。

webHookUrl

string

可选

异步任务结束时，会触发Web Hook 接口的http请求接口，可用于接收相关任务相关信息。可用于通知。默认为空字符串。对接口的要求：POST 请求，且body为json类型。**对该接口的调用超时时间是3s中，所以对该服务接口的时间，建议接收到消息后，进行一步处理，避免逻辑运行阻塞导致超时。**对该接口的响应内容不做任何处理。仅对code是否为0，不为0 做错误日志记录

name

string

任务名称

可选

userId

string

用户唯一标识

可选

extension

string

可选

可用来存储额外信息，不支持模糊查询,该属性不能用来查询过滤

tool

string

必需

工具名称，或者工具id

示例

{
    "tool": "KQGPToolRasterToLine",
    "distributed": true,
    "params": {
        "_ServerUrl": "{\"paramBase\":{\"height\":0,\"isConnectParam\":false,\"isEnable\":true,\"isRequest\":true,\"isVisible\":true,\"isVisibleDisplayName\":true,\"width\":0},\"value\":\"http://172.4.2.228:8299/taskmanager\"}",
        "_MetaFile": "{\"fileDir\":\"\",\"isEditable\":true,\"isSave\":false,\"paramBase\":{\"height\":0,\"isConnectParam\":false,\"isEnable\":true,\"isRequest\":true,\"isVisible\":true,\"isVisibleDisplayName\":true,\"width\":0},\"suffix\":\"*.xml\",\"value\":\"D:/source/KQGIS/32suo/01测试数据/倾斜摄影/metadata.xml\"}",
        "_DataFolder": "{\"filePath\":\"D:/source/KQGIS/32suo/01测试数据/倾斜摄影/Data\",\"fileSuffixList\":[],\"isEditable\":true,\"paramBase\":{\"height\":0,\"isConnectParam\":false,\"isEnable\":true,\"isRequest\":true,\"isVisible\":true,\"isVisibleDisplayName\":true,\"width\":0}}",
        "_TextureType": "{\"list\":[{\"paramBase\":{\"height\":0,\"isConnectParam\":false,\"isEnable\":true,\"isRequest\":true,\"isVisible\":true,\"isVisibleDisplayName\":true,\"width\":0},\"value\":\"true\"},{\"paramBase\":{\"height\":0,\"isConnectParam\":false,\"isEnable\":true,\"isRequest\":true,\"isVisible\":true,\"isVisibleDisplayName\":true,\"width\":0},\"value\":\"false\"}],\"paramBase\":{\"height\":0,\"isConnectParam\":false,\"isEnable\":true,\"isRequest\":false,\"isVisible\":true,\"isVisibleDisplayName\":true,\"width\":0},\"type\":0}",
        "_OutFolder": "{\"filePath\":\"D:/source/KQGIS/32suo/11\",\"fileSuffixList\":[],\"isEditable\":true,\"paramBase\":{\"height\":0,\"isConnectParam\":false,\"isEnable\":true,\"isRequest\":true,\"isVisible\":true,\"isVisibleDisplayName\":true,\"width\":0}}",
        "_OutputJsonName": "{\"paramBase\":{\"height\":0,\"isConnectParam\":false,\"isEnable\":true,\"isRequest\":true,\"isVisible\":true,\"isVisibleDisplayName\":true,\"width\":0},\"value\":\"tileset\"}",
        "_MaxRootCount": "{\"lower\":\"-128\",\"number\":{\"isNull\":false,\"paramBase\":{\"height\":0,\"isConnectParam\":false,\"isEnable\":true,\"isRequest\":true,\"isVisible\":true,\"isVisibleDisplayName\":true,\"width\":0},\"paramUIType\":1},\"upper\":\"127\",\"value\":\"0\"}",
        "_NodeCount": "3",
        "_ThreadCountPerNode": "3"
    },
    "asyn": true
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/rest/services/tool/runmodel' \
--header 'Content-Type: application/json' \
--data-raw '{
    "tool": "KQGPToolRasterToLine",
    "distributed": true,
    "params": {
        "_ServerUrl": "{\"paramBase\":{\"height\":0,\"isConnectParam\":false,\"isEnable\":true,\"isRequest\":true,\"isVisible\":true,\"isVisibleDisplayName\":true,\"width\":0},\"value\":\"http://172.4.2.228:8299/taskmanager\"}",
        "_MetaFile": "{\"fileDir\":\"\",\"isEditable\":true,\"isSave\":false,\"paramBase\":{\"height\":0,\"isConnectParam\":false,\"isEnable\":true,\"isRequest\":true,\"isVisible\":true,\"isVisibleDisplayName\":true,\"width\":0},\"suffix\":\"*.xml\",\"value\":\"D:/source/KQGIS/32suo/01测试数据/倾斜摄影/metadata.xml\"}",
        "_DataFolder": "{\"filePath\":\"D:/source/KQGIS/32suo/01测试数据/倾斜摄影/Data\",\"fileSuffixList\":[],\"isEditable\":true,\"paramBase\":{\"height\":0,\"isConnectParam\":false,\"isEnable\":true,\"isRequest\":true,\"isVisible\":true,\"isVisibleDisplayName\":true,\"width\":0}}",
        "_TextureType": "{\"list\":[{\"paramBase\":{\"height\":0,\"isConnectParam\":false,\"isEnable\":true,\"isRequest\":true,\"isVisible\":true,\"isVisibleDisplayName\":true,\"width\":0},\"value\":\"true\"},{\"paramBase\":{\"height\":0,\"isConnectParam\":false,\"isEnable\":true,\"isRequest\":true,\"isVisible\":true,\"isVisibleDisplayName\":true,\"width\":0},\"value\":\"false\"}],\"paramBase\":{\"height\":0,\"isConnectParam\":false,\"isEnable\":true,\"isRequest\":false,\"isVisible\":true,\"isVisibleDisplayName\":true,\"width\":0},\"type\":0}",
        "_OutFolder": "{\"filePath\":\"D:/source/KQGIS/32suo/11\",\"fileSuffixList\":[],\"isEditable\":true,\"paramBase\":{\"height\":0,\"isConnectParam\":false,\"isEnable\":true,\"isRequest\":true,\"isVisible\":true,\"isVisibleDisplayName\":true,\"width\":0}}",
        "_OutputJsonName": "{\"paramBase\":{\"height\":0,\"isConnectParam\":false,\"isEnable\":true,\"isRequest\":true,\"isVisible\":true,\"isVisibleDisplayName\":true,\"width\":0},\"value\":\"tileset\"}",
        "_MaxRootCount": "{\"lower\":\"-128\",\"number\":{\"isNull\":false,\"paramBase\":{\"height\":0,\"isConnectParam\":false,\"isEnable\":true,\"isRequest\":true,\"isVisible\":true,\"isVisibleDisplayName\":true,\"width\":0},\"paramUIType\":1},\"upper\":\"127\",\"value\":\"0\"}",
        "_NodeCount": "3",
        "_ThreadCountPerNode": "3"
    },
    "asyn": true
}'

返回响应

🟢200成功

application/json

Body

object {0}

示例

{
    "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
            }
        ],
        "taskID": "gp_{5e071cff-68f2-4c7d-ad06-2f42514e68a0}"
    },
    "resultcode": "success"
}