获取要素集合(featureList)

POST

/rest/services/{servicename}/data/featurelist

查询获取要素集合，该接口不进行条件过滤，是对要素集中要素的遍历输出，以在数据集中存储的顺序排序。
备注：
要素集查询需要考虑多线程，建议服务内部构建连接池，从连接池动态获取连接信息，并设定超时信息，并定时清理超时的数据库连接，以便释放资源。以下接口相同，不在重复说明

请求参数

Path 参数

servicename

string

必需

Body 参数application/json

layerId

string

必需

地图服务的数据服务调用时起到作用，图层Id，优先级高于layerName。

layerName

string

必需

地图服务的数据服务调用时起到作用，图层名称。

datasourceID

string

必需

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

datasourceName

string

数据源名称。

可选

parentDatasetName

string

必需

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

datasetName

string

数据集名称

必需

datasetID

string

可选

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

fromIndex

integer

可选

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

toIndex

integer

可选

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

outSRS

string

可选

结果数据集的空间参考。

returnContent

boolean

可选

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

hasGeometry

boolean

可选

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

returnZM

boolean

可选

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

returnBlobField

boolean

可选

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

connInfo

object (ConnectionInfo)

可选

【connInfo`对象】支持的对象数据源连接信息，动态打开数据源，功能和其他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,MongoDB

filepath

string

可选

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

server

string

可选

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

instance

string

可选

数据库实例名或端口

database

string

数据库名称

可选

user

string

数据源用户名

可选

password

string

数据库密码

可选

dataset_name

string

表名

可选

示例

{
    "datasourceName":"china",
    "datasetName":"road",
    "fromIndex": 0, // 前面19个要素
    "toIndex":19,
    "returnContent":true, // true时返回要素集合
    "hasGeometry":false
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/rest/services//data/featurelist' \
--header 'Content-Type: application/json' \
--data-raw '{
    "datasourceName":"china",
    "datasetName":"road",
    "fromIndex": 0, // 前面19个要素
    "toIndex":19,
    "returnContent":true, // true时返回要素集合
    "hasGeometry":false
}'

返回响应

🟢200成功

application/json

Body

resultcode

string

必需

示例

只返回ID返回具体的要素内容

{
    "resultcode": "success",    //返回结果代码，”success”表示成功，”error”表示失败
    "result":
    {
        "featureIDs":[id1,id2],//返回ID集合，配合id获取要素集合,
        "featureCount":186,//要素集中要素的总数量。
        "geometryType":"Line",//几何类型，对应几何对象枚举
        "startID":0 //要素集合中要素的起始位置，其值与请求时设置的 fromIndex 可能相等，除非中间有删除过此ID的要素
    }
}

🟢200只返回要素ID成功

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

删除字段(field)

通过ids获取要素集合(featureByIDs)