要素识别(identify)

POST

/rest/services/{servicename}/data/identify

根据指定的区域识别要素（多图层），一般是小区域数据查询，不支持异步，不支持动态连接；
只支持基于空间查询的过滤条件(所有查询数据共用一个过滤范围)，不支持where条件过滤等；
一般不建议传递比较大的空间范围进行过滤，大范围应该使用 featurequery；
此接口应该多用于地图服务进行小范围的要素识别。
请求示例

请求json

{
    "datasourceName":["china"],
    "datasetName":["road"], // 这里的datasourceName与datasetName进行一一对应
    "filter":{filter object}, // 必须存在且为空间过滤
    "returnContent":true, // true时返回features，false返回ID集合
    "hasGeometry":true, // 在returnContent为true，true时返回geometry
}

有父数据集

{
    "datasourceName":["china", "china2"],
    "parentDatasetName": ["par1", "par2"],
    "datasetName":["road", "road2"], // 这里的datasourceName, parentDatasetName与datasetName进行一一对应
    "filter":{filter object}, // 必须存在且为空间过滤, 所有数据共用一个过滤
    "returnContent":true, // asyn为false时有效，true时返回features，false返回ID集合
    "hasGeometry":true, // 在returnContent为true、asyn为false时有效，true时返回geometry，
}

通过图层id 方式

{
    "layerId":["0"],
    "filter":{filter object}, // 必须存在且为空间过滤
    "returnContent":true, // true时返回features，false返回ID集合
    "hasGeometry":true, // 在returnContent为true，true时返回geometry，
    "scale":1000 //比例尺分母
}

请求参数

Path 参数

servicename

string

必需

Body 参数application/json

layerName

array[string]

必需

图层名称数组，如果不设置，则获取全部图层的信息。

layerId

array[string]

必需

图层id数组，如果不设置，则获取全部图层的信息。和layerName效果一致，需要具有唯一性。优先级高于layerName。

scale

number

可选

地图比例尺，用于判断图层是否在显示范围内，如果不设置，则不判断，所有传入图层认为均可查询。

mode

number

可选

查询模式有top、 visible和all三种，默认all。分别代表最上层，可见和全部。

tolerance

integer

可选

屏幕像素与应执行识别操作的指定几何图形的距离。容差的值是一个整数。根据传入的几何及空间参考，转换成对应的地理坐标。当传入图形是点时默认 tolerance=2，当传入图形不是点时默认 tolerance=0

dpi

integer

可选

每英寸点数，默认96。

datasourceName

array[string]

数据源名称

必需

datasourceID

array[string]

可选

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

parentDatasetName

array[string]

可选

父数据集名称, 对于名称对外重复的情况下会需要，比如海图, 需要与下面的datasetName一一对应

datasetName

array[string]

必需

数据集名称, 与datasourceName或datasourceID个数一致，并一一对应

datasetID

array[string]

可选

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

filter

object (Filter)

必需

查询过滤条件对象,。查询条件，数量为1或者和查询数据集数量相同。数量为1时，所有查询图层均使用相同查询条件，否则按照对应索引匹配对应数据集的查询条件。

where

string

可选

查询条件，使用url编码之后的字符串，例如 PAC=420804 or PAC=420802

geometry

string

可选

查询几何对象，geojson格式字符串，具体参见 “geojson 对象” geojson 对象
此参数如果在设置了query_define 中的geometry 参数后，会无效，会被覆盖。需要对字符串进行转义，例如：{ "type": "Polygon", "coordinates": [ [ [ 111.989792031851962, 31.427141945448305 ], [ 111.556656081144411, 30.94937986648603 ], [ 112.147296013927445, 30.639622035070929 ], [ 112.562056500059526, 30.999256127476599 ], [ 111.989792031851962, 31.427141945448305 ] ] ] }

subfields

string

可选

查询返回的字段，以逗号隔开，如果为空，则返回所有字段，例如：PAC,NAME

GroupByClause

string

可选

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

OrderByClause

string

可选

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

SpatialRel

string

可选

查询空间判断过滤类型

limit

string

可选

制返回数量，默认全部返回，如果传值小于0 则设置为200

Fids

array[string]

可选

过滤要素id数组,优先级最高

geoSRS

string

可选

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

returnContent

boolean

可选

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

hasGeometry

boolean

可选

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

returnZM

boolean

可选

是否返回图形信息里面的ZM值(如果有的话)，默认为false, hasGeometry为true的时候才有用

returnBlobField

boolean

可选

是否返回属性值的二进制属性内容，默认为false, returnContent 为true的时候才有用, 返回形式为base64编码

outSRS

string

必需

输出空间参考，所有数据集查询结果均按照该空间参考进行查询。如果未设置则按照数据集空间参考返回。

示例

{
    "request": "identify",
    "datasourceName":["china"],
    "datasetName":["road"], // 这里的datasourceName与datasetName进行一一对应
    "filter":{filter object}, // 必须存在且为空间过滤
    "returnContent":true, // true时返回features，false返回ID集合
    "hasGeometry":true, // 在returnContent为true，true时返回geometry
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/rest/services//data/identify' \
--header 'Content-Type: application/json' \
--data-raw '{
    "request": "identify",
    "datasourceName":["china"],
    "datasetName":["road"], // 这里的datasourceName与datasetName进行一一对应
    "filter":{filter object}, // 必须存在且为空间过滤
    "returnContent":true, // true时返回features，false返回ID集合
    "hasGeometry":true, // 在returnContent为true，true时返回geometry
}'

返回响应

🟢200成功

application/json

Body

object {0}

示例

有成功的情况失败

{
    "resultcode": "success",    //返回结果代码，”success”表示成功，”error”表示失败, 对于失败的情况加了一个failedResult
    "result":[
        {
            "layerId":"layer1",
            "datasetName":"name1",
            "datasourceName":"ds1",
            "featureCount": 10,
            "featureIDs": [],
            "features": {FeatureCollection GeoJson object}
            "totalCount": 100
        },
    ],
    "failedResult": {
        "layerID or datasetName": "错误原因"
    }
}

修改于 2024-12-02 07:10:58

批量查询(batchQuery)

获取要素查询结果集信息(featureResultInfo)