空间关系分析(relation) - kqgis server v8.5

请求参数

Path 参数

servicename

string

必需

Body 参数application/json

srcDataset

object (数据集连接对象)

必需

空间关系分析中的源数据集，具体参见 “数据集信息datasetinfo” 数据集信息datasetinfo

layerid

string

可选

图层id，通过地图服务配置方式发布下可用，优先级最高

datasourceName

string

数据源名称

可选

datasourceID

string

可选

数据源ID ，和datasourceName功能相同，用于确定数据源。二选一，优先级高于datasourceName。

datasetName

string

数据集名称

可选

datasetID

string

可选

每个数据集对应一个唯一标识ID，可替换数据源名称+数据集名称，确定一个唯一数据集。效果可数据源名称+数据集名称相同。二选一，优先级高，规则参考数据服务中的id规则。

geometry

string

可选

Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection类型的GeoJson对象具体参见 “geojson 对象” geojson 对象

refDataset

object (数据集连接对象)

必需

空间关系分析中的参考数据集，具体参见 “数据集信息datasetinfo” 数据集信息datasetinfo

srcDatasetFilter

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

refDatasetFilter

object (Filter)

可选

空间关系分析中的参考数据集查询过滤条件

operateType

string

必需

指定的空间关系类型，参考通用参数说明下面的相关枚举说明，具体参见相关枚举说明

returnGeoRelatedOnly

boolean

可选

仅返回满足指定空间关系的空间对象，默认为 true。即如果不满足关系结果是空的，则不在结果中体现。

默认值:

true

startRecord

integer

可选

分析结果起始记录位置，默认为0。结果的第几条记录开始返回输出。结合returnCount 可实现分页

默认值:

0

returnCount

integer

可选

空间关系分析期望返回结果最大记录数，默认为200条，如果实际不足200条结果则返回所有分析结果。

默认值:

200

returnRefResultType

integer

可选

返回参考数据集中结果要素信息类型支持:0，不返回，1 返回Feature 信息仅包含几何，2 返回Feature 信息仅包含属性，3，返回Feature 信息包含几何和属性；4，仅返回id 。默认为3。控制响应中refResultFeatures。

>= 0<= 4

默认值:

3

returnSrcResultType

integer

可选

返回源数据集中结果要素信息类型支持:0，不返回，1 返回Feature 信息仅包含几何，2 返回Feature 信息仅包含属性，3，返回Feature 信息包含几何和属性；4，仅返回id 。默认为3。控制响应中srcResultFeatures。

>= 0<= 4

默认值:

3

returnDetail

boolean

可选

是否返回详细关系信息，默认为true。当returnDetail为true，returnRefResultType和returnSrcResultType可用值为0,1,2,3。
当returnDetail为false 时，returnRefResultType和returnSrcResultType值一般为4。
满足两种不同的应用场景。

默认值:

true

outSRS

string

结果的空间参考

可选

aysn

boolean

可选

是否异步执行，如果异步执行，直接返回任务id，通过任务状态查询返回结果。默认同步。

默认值:

true

示例

{
    "srcDataset":
    {
        "datasourceName": "HuBei", 
        "datasetName": "dltb2020"
    },
    "srcDatasetFilter":
    {
        "where": "dlbm = '0201' OR dlbm = '0202'",
        "geometry": 
        {
            "type":"Polygon",
            "coordinates":[[[39534640.8139820099,3345625.0066242237],[39534640.8139820099,3348795.9912395477],
                            [39538068.2273349762,3348795.9912395477],[39538068.2273349762,3345625.0066242237],[39534640.8139820099,3345625.0066242237]]]
        },
        "SpatialRel": "Intersects"
    },
    "refDataset":
    {
        "datasourceName": "HuBei",
        "datasetName": "dltb2021"
    },
    "refDatasetFilter":
    {
        "geometry": 
        {
            "type":"Polygon",
            "coordinates":[[[39534640.8139820099,3345625.0066242237],[39534640.8139820099,3348795.9912395477],
                            [39538068.2273349762,3348795.9912395477],[39538068.2273349762,3345625.0066242237],[39534640.8139820099,3345625.0066242237]]]
        },
        "SpatialRel": "Intersects"
    },
    "operateType":"Intersect",
    "returnDetail":true,
    "returnRefResultType": 0,
    "returnSrcResultType": 0,
    "outSRS":"EPSG:4326",
    "returnGeoRelatedOnly":true,
    "startRecord":0,
    "returnCount":200,
    "aysn":false
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/rest/services//spatialanalysis/relation' \
--header 'Content-Type: application/json' \
--data-raw '{
    "srcDataset":
    {
        "datasourceName": "HuBei", 
        "datasetName": "dltb2020"
    },
    "srcDatasetFilter":
    {
        "where": "dlbm = '\''0201'\'' OR dlbm = '\''0202'\''",
        "geometry": 
        {
            "type":"Polygon",
            "coordinates":[[[39534640.8139820099,3345625.0066242237],[39534640.8139820099,3348795.9912395477],
                            [39538068.2273349762,3348795.9912395477],[39538068.2273349762,3345625.0066242237],[39534640.8139820099,3345625.0066242237]]]
        },
        "SpatialRel": "Intersects"
    },
    "refDataset":
    {
        "datasourceName": "HuBei",
        "datasetName": "dltb2021"
    },
    "refDatasetFilter":
    {
        "geometry": 
        {
            "type":"Polygon",
            "coordinates":[[[39534640.8139820099,3345625.0066242237],[39534640.8139820099,3348795.9912395477],
                            [39538068.2273349762,3348795.9912395477],[39538068.2273349762,3345625.0066242237],[39534640.8139820099,3345625.0066242237]]]
        },
        "SpatialRel": "Intersects"
    },
    "operateType":"Intersect",
    "returnDetail":true,
    "returnRefResultType": 0,
    "returnSrcResultType": 0,
    "outSRS":"EPSG:4326",
    "returnGeoRelatedOnly":true,
    "startRecord":0,
    "returnCount":200,
    "aysn":false
}'

返回响应

🟢200成功

application/json

Body

reference

integer

可选

在操作数据集中与源空间对象满足指定空间关系的对象ID数组。

count

integer

可选

在操作数据集中与源空间对象满足指定空间关系的对象个数。

source

integer

源空间对象ID

可选

示例

成功示例returnDetail为true时成功示例returnDetail为false时异步返回

{
    "resultcode": "success",
    "time": 0.343,
    "result": {
        "refResultFeatures": "{Geojson Feature}",
        "srcResultFeatures": "{Geojson Feature}",
        "detail": [
            {
                "reference": "[id1,id2]",
                "source": 1,
                "count": 2
            },
            {
                "reference": "[id4]",
                "source": 2,
                "count": 1
            },
            {
                "reference": [],
                "source": 3,
                "count": 0
            }
        ]
    }
}

🟢200异步成功