datasetList - kqmicrogo

请求参数

Header 参数

ua_token

string

可选

默认值:

Body 参数application/json

request

string

必需

处理方法 datasetList

datasourceName

string

必需

数据源名称，此参数要求发布多个数据源名称保持唯一

datasourceID

array[string]

可选

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

parentdatasetname

string

可选

父数据集名称，如果不为空，则查找指定数据集下面的指定类型的列表。

datasetType

array[string]

可选

数据集类型，可选，当为空或不传时，列出所有支持的类型。

geometryType

string

可选

要素类型，可选，为point/polyline/polygon，如果传了此参数，datasetType参数默认featureClass；当为空或不传时，返回所有类型。

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

表名

可选

onlyPublish

boolean

可选

是否仅返回已发布的数据集列表，true，仅返回符合条件的已发布的列表，false则返回数据源下所有的数据集列表。默认为true。

默认值:

true

示例

{
   "request": "datasetList",
   "datasourceName":"China",
   "datasetType":"featureClass"
}

示例代码

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/datasetlist' \
--header 'ua_token: ' \
--header 'Content-Type: application/json' \
--data-raw '{
   "request": "datasetList",
   "datasourceName":"China",
   "datasetType":"featureClass"
}'

返回响应

🟢200成功

application/json

Body

resultcode

string

必需

result

object

必需

datasetCount

integer

数量

必需

datasets

array [object {7}]

必需

示例

{
    "resultcode": "success",
    "result": {
        "datasetCount": 2,
        "datasets": [
            {
                "datasetName": "road",
                "datasetID": "roadID",
                "datasetType": "featureDataset",
                "published": true,
                "isParentDataset": true
            },
            {
                "datasetName": "live",
                "datasetID": "liveID",
                "datasetType": "featureClass",
                "geometryType": "polygon",
                "published": true,
                "isParentDataset": false,
                "parentDatasetName": "road"
            }
        ]
    }
}