要素删除(featureOperate)

DELETE

/rest/services/{servicename}/data/featureoperate

删除要素。
注意点

要素进行添加或修改时，feature结构需要在请求体中包含添加/修改的要素信息集合，其中单个要素信息的参考feature 结构信息。
对要素进行删除时（method=DELETE），通过查询过滤条件进行删除，需要在FIlter对象中包含欲删除要素的 ID 数组或SQL查询条件。
对于删除或更新中，filter 错误导致的失败，会返回error；对于filter正常，但是无法找到有效项的情况，返回success;
result里面添加新的项， successCount 代表成功的项。
对应批量更新操作，要求参数
请求示例

通过过滤器删除

{
    "Request-Method":"DELETE",
    "datasourceName":"china",
    "datasetName":"road"，
    "filter":{filter object}
}

通过id删除

{
    "Request-Method":"DELETE",
    "datasourceName":"china",
    "datasetName":"road"，
    "ids":[17]
}

请求参数

Path 参数

servicename

string

必需

Body 参数application/json

Request-Method

string

必需

操作类型，支持POST、DELETE、PUT，分别表示添加要素、删除要素、修改要素

layerId

string

必需

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

layerName

string

必需

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

datasourceID

string

必需

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

datasourceName

string

数据源名称

必需

parentDatasetName

string

可选

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

datasetName

string

数据集名称。

必需

datasetID

string

可选

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

filter

object (Filter)

查询过滤条件对象。

可选

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

useBatch

boolean

可选

值为true时，则开启事务, false 时，不开启事务，默认true

features

object

可选

Feature或FeatureCollection类型的GeoJson对象，具体参见 “geojson 对象” geojson 对象

geoSRS

string

可选

features中的图形空间参考，值空或者无此项时为当前要素表的空间参考

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

表名

可选

示例

{
    "Request-Method":"DELETE",
    "datasourceName":"china",
    "datasetName":"road",
    "filter":{filter object}
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request DELETE '/rest/services//data/featureoperate' \
--header 'Content-Type: application/json' \
--data-raw '{
    "Request-Method":"DELETE",
    "datasourceName":"china",
    "datasetName":"road",
    "filter":{filter object}
}'

返回响应

🟢200成功

application/json

Body

resultcode

string

必需

示例

{
    "resultcode": "success" or "error",
    "result" : {
        "failedResult": [], // 失败的ID
        "successCount": 2    // 更新或删除成功的个数
    }
}

修改于 2024-10-09 09:30:01

要素增加(featureOperate)

要素修改(featureOperate)