tool


URI

<geoprocessing_uri>/gp/v2/{toolID}[.<format>]

支持的方法

GETHEAD

父资源

georpocessing

子资源

executejobs

介绍

tool资源对应相应的地理处理工具描述信息,包含该工具的名称、描述、输入参数、环境参数和输出结果相关参数。

支持的方法:

支持的表述格式:RJSON、JSON、HTML、XML。

资源层次

HTTP 请求方法

对如下 URI 执行 HTTP 请求,以 rjson 输出格式为例加以说明,其中,supermapiserver 是服务器名。

http://supermapiserver:8090/iserver/services/geoprocessing/restjsr/gp/v2/bdt-vec-io:countrdd.rjson

GET 请求

获取地理处理工具的描述信息,包括工具的ID、名称、描述、输入参数、环境参数和输出结果相关参数。

响应结构

对地理处理工具描述信息资源执行GET请求,在响应消息的实体主体里是一个地理处理工具信息资源描述集,其中单个资源描述的结构如下:

字段 类型 说明
id String 地理处理工具ID。
title String 地理处理工具名称。
description String 地理处理工具的描述。
inputs String 地理处理工具的输入参数描述信息。
outputs String 地理处理工具的输出结果描述信息。
environment String 地理处理工具的环境参数描述信息。

响应示例

对地理处理工具描述信息资源执行GET请求,返回rjson格式的资源描述如下:

{

  "outputs": [{

    "dataType": "long",

    "isCollection": false,

    "description": "RDD 中要素对象的数目",

    "id": "resultCount",

    "title": "RDD 中要素对象的数目"

  }],

  "environment":[ {

    "type":"BDT_Spark_Environment",

    "settings": [],

    "appName": "",

    "master": ""

   }],

  "inputs": [{

    "isRequired": true,

    "defaultValue": "",

    "meta": {},

    "dataType": "com.supermap.bdt.FeatureRDD",

    "isCollection": false,

    "description": "输入的要素数据集",

    "enumItems": "",

    "id": "inputRDD",

    "title": "输入的要素数据集"

  }],

  "description": "计算要素数据集中要素对象的数目",

  "id": "bdt-vec-io:countrdd",

  "title": "计数"

}

HEAD 请求

返回跟 GET 请求一样的 HTTP 响应头,但是没有响应实体。可以在不必传输整个响应内容的情况下,获取包含在响应消息头中的元数据信息。元数据信息包括媒体类型,字符编码,压缩编码,实体内容长度等。

HEAD 请求可以用来判断 tool 资源是否存在,或者客户端是否有权限访问 tool 资源。通过对加.<format>的 URI 执行 HEAD 请求,还可以快速判断 tool 资源是否支持<format>格式的表述。

请参见