featureQuery - kqmicrogo

请求参数

Header 参数

ua_token

string

可选

默认值:

Body 参数application/json

request

string

必需

处理方法 featureQuery

datasourceName

string

数据源名称。

必需

datasourceID

string

必需

数据源ID ，和datasourceName功能相同，用于确定数据源。服务重启（持久化后再加载）保证一致性。二选一。

layerId

string

必需

地图服务的数据服务调用时生效，图层ID，优先级高于layerName。

layerName

string

必需

地图服务的数据服务调用时生效，图层名称。

datasetID

string

可选

每个数据集对应一个唯一标识ID，可替换数据源名称+数据集名称确定一个唯一数据集。效果可数据源名称+数据集名称相同。二选一，优先级高。

datasetName

string

数据集名称。

必需

filter

object (Filter)

查询过滤条件对象。

可选

where

string

查询过滤条件

可选

subfields

string

可选

查询返回的字段，以逗号隔开，例如：PAC,NAME

geometry

object

可选

查询几何对象，geojson格式字符串

geoSRS

string

可选

查询几何对象的空间参考信息，支持EPSG、WKT、proj4字符串参数，例如epsg类型 EPSG:4490

SpatialRel

string

可选

查询空间判断过滤类型

limit

string

可选

限制返回数量，默认全部返回

GroupByClause

string

可选

分组条件，sdk底层支持，传入参数字段名称，多个字段以 , 逗号分割，例如 id,name

OrderByClause

string

可选

排序条件，sdk底层支持，传入参数字段名称 + desc/asc，多个字段排序使用 , 逗号分割。举例： id desc,name asc

fromIndex

integer

可选

查询结果的起始索引号，默认值是0，如果该值大于查询结果的最大索引号，则查询结果为空。对应数据存储的顺序，不是id。

toIndex

integer

可选

查询结果的最大索引号。如果该值大于查询结果的最大索引号，则以查询结果的最大索引号为终止索引号。
如果设置了此值，则必须大于fromIndex，如果小于fromIndex，则查询为错误；设置了此值，但是值无效，则会默认为19
没设置此值时，返回所有，可能会比较慢。

outSRS

string

可选

结果数据集的空间参考。

returnContent

boolean

可选

是否返回要素信息（属性和图形信息），默认为false，只返回要素的id。true时，返回要素信息。

hasGeometry

boolean

可选

是否返回要素图形信息，默认为false，不返回要素图形信息，true时，返回要素图形信息。在returnContent为true、sync为false时，该参数有效。

asyn

boolean

可选

false表示直接返回查询结果，即元素类型为 Feature 的数组;true表示异步执行查询，返回创建的 featureResult 资源的 name。默认不传时为 true。

connInfo

object (ConnectionInfo)

必需

数据源连接信息，动态打开数据源，功能和其他datasourceID和datasourceName、destDatasetName、datasetName等参数的组合类似，互斥关系，且优先级优先级高于其他组合。该参数用于全局通用数据服务，根据临时连接信息动态打开数据源或数据集。

connecttype

string

必需

数据源类型，支持 Folder,RelationalDB_Access,KQSpatialDB,KQPostgisDB,RelationalDB_PostgreSQL,RelationalDB_Kingbase8,RelationalDB_MySql,RelationalDB_SQL,RelationalDB_OCI11,RelationalDB_DM,S57,GDB,GeoJSON。

filepath

string

可选

文件路径，当数据源为文件或文件目录时有效，数据源类型为Folder,RelationalDB_Access,KQSpatialDB为文件型数据源。

folderpath

string

可选

文件夹路径，当数据源为文件或文件目录时有效，数据源类型为Folder

server

string

可选

数据库服务器地址(IP或机器名)

instance

string

可选

数据库实例名或端口

database

string

数据库名称

可选

user

string

数据源用户名

可选

password

string

数据库密码

可选

dataset_name

string

表名

可选

示例

{
    "datasourceName":"OrclData",
    "datasetName": "XZQ",
    "filter": {
        "geoSRS":"EPSG:4527",
        "geometry": { "type": "Polygon", "coordinates": [ [ [ 39535937.979274631, 3347750.0630558687 ], [ 39536966.202642649, 3347750.0630558687 ], [ 39536966.202642649, 3346637.903086381 ], [ 39535937.979274631, 3346637.903086381 ], [ 39535937.979274631, 3347750.0630558687 ] ] ] },
        "SpatialRel": "Intersects"
    },
    "outSRS": "EPSG:4527",
    "returnContent": true,
    "hasGeometry": false,
    "fromIndex": 0,
    "toIndex": 20,
    "asyn": "false"
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'http://172.16.1.44:9800/rest/services/common/commondata/featurequery' \
--header 'ua_token: ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "datasourceName":"OrclData",
    "datasetName": "XZQ",
    "filter": {
        "geoSRS":"EPSG:4527",
        "geometry": { "type": "Polygon", "coordinates": [ [ [ 39535937.979274631, 3347750.0630558687 ], [ 39536966.202642649, 3347750.0630558687 ], [ 39536966.202642649, 3346637.903086381 ], [ 39535937.979274631, 3346637.903086381 ], [ 39535937.979274631, 3347750.0630558687 ] ] ] },
        "SpatialRel": "Intersects"
    },
    "outSRS": "EPSG:4527",
    "returnContent": true,
    "hasGeometry": false,
    "fromIndex": 0,
    "toIndex": 20,
    "asyn": "false"
}'

返回响应

🟢200成功

application/json

Body

result

object

必需

featureCount

integer

本次返回的记录数量

必需

features

object

必需

totalCount

integer

必需

符合条件的记录总数量

resultcode

string

必需

示例

{
    "result": {
        "featureCount": 1,
        "features": {
            "features": [
                {
                    "properties": {
                        "AA": 3953464081398200,
                        "BGRQ": "3953806822733500",
                        "BSM": "341721121000000005",
                        "BZ": "",
                        "JSMJ": 5960135.92,
                        "KID": 5,
                        "KZMJ": 5959975.1,
                        "MSSM": "00",
                        "PCMJ": 5959975.11,
                        "XZQDM": "341721130006",
                        "XZQMC": "泥黄村",
                        "YSDM": "1000600100"
                    },
                    "type": "Feature"
                }
            ],
            "type": "FeatureCollection"
        },
        "totalCount": 9
    },
    "resultcode": "success"
}