datasetInfo

http://172.16.1.44:9800

POST

/rest/services/common/commondata/datasetinfo

获取数据集元数据信息，支持批量查询。

请求参数

Header 参数

ua_token

string

可选

默认值:

Body 参数application/json

request

string

必需

处理方法 datasetInfo

datasourceName

string

数据源名称

必需

datasetName

array[string]

数据集名称

必需

datasourceID

string

可选

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

datasetID

array[string]

可选

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

parentDatasetName

string

可选

父数据集名称，如果不为空，则datasetNames必须是此数据集下的不然返回空；如果为空，则会直接查找整个数据源下的子数据集。

returnfieldinfos

boolean

可选

默认为false，不返回字段信息，true为返回字段元数据信息。

connectType

integer

可选

默认0，不返回连接信息，1返回 8.5格式connectinfo。

returnpassword

boolean

可选

当存在安全连接信息时，如数据库连接，控制是否返回密码，默认false，不返回密码信息，安全起见;true，为返回连接信息的密码，可用于后端服务间传递。connectType不为0时有效。

onlyPublish

boolean

可选

是否只查询已发布的数据的信息，

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

表名

可选

示例

{
    "request": "datasetInfo",
    "datasourceName":"china",
    "parentDatasetName": "pointDataset",
    "datasetName":["facilityPoint"],
    "returnfieldinfos":false
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://172.16.1.44:9800/rest/services/common/commondata/datasetinfo' \
--header 'ua_token: ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "request": "datasetInfo",
    "datasourceName":"china",
    "parentDatasetName": "pointDataset",
    "datasetName":["facilityPoint"],
    "returnfieldinfos":false
}'

返回响应

🟢200成功

application/json

Body

datasetInfo

object

数据集详细信息

可选

name

string

可选

数据集名称，数据集的唯一标识。该标识不区分大小写

description

string

数据集的描述信息

可选

type

string

可选

数据集类型。支持数据集类型，

geometryType

string

可选

要素类型，为point/polyline/polygon，type为featureClass时才会返回此值

extend

number

可选

数据集范围。对于矢量数据集来说，extend 为数据集中所有对象的最小外接矩形；对于栅格，extend为当前格网或影像的地理范围。格式如下[minx,miny,maxx,maxy]

dataSourceName

string

可选

该数据集对象所属的数据源名称。- 目前没有专门的数据源名称

srs

object

可选

数据集的空间参考信息，包括epsg、wkt和proj4三种格式的字符串

tableName

string

可选

表名。对数据库型数据源，指此数据集在数据库中所对应的数据表名称；对文件型数据源，指此数据集存储属性的表名称（文件型数据源文件用.kqdb 文件存储空间数据）

encoding

string

可选

矢量数据集的字符集。仅当 dataset 资源标识的是矢量数据集时存在

recordCount

integer

可选

矢量数据集中的记录数。仅当 dataset 资源标识的是矢量数据集时存在

fields

object (Field)

可选

矢量数据集是有效，返回字段元数据集合

height

integer

可选

数据的高度。仅当 dataset 资源标识的是影像数据集时存在。

width

integer

可选

数据的宽度。仅当 dataset 资源标识的是影像数据集时存在

pixelFormat

object

可选

数据存储的像素格式。仅当 dataset 资源标识的是影像数据集时存在

isMultiBand

boolean

可选

影像数据集是否是多波段影像数据集。仅当 dataset 资源标识的是影像数据集时存在

bandCount

integer

波段数

可选

useNodata

boolean

是否使用无效值

可选

nodata

number

可选

无效值, 根据像素格式可转换为不同类型的值（int16), int32等

connectInfo

object

可选

示例

{
    "resultcode": "success",
    "result": {
        "datasetInfos": [
            {
                "datasetInfo": "DatasetInfo Object",
                "ConnectionInfo": "connectInfo object"
            },
            {
                "datasetInfo": "DatasetInfo Object",
                "ConnectionInfo": "connectInfo object"
            }
        ],
        "connectType": 1
    }
}

修改于 2023-06-08 03:06:51

datasetList

fieldList