URI

/datasets[.<format>]

Supported methods

GET,HEAD

Parent resource

data

Child resource

dataDatasetInfo

Introduction

dataDatasets resource is a collection resource of all datasets in a data item.

Supported methods:

  • GET:Retrieves the dataset information contained in the data.
  • HEAD: Checks whether the Datasets resource exists or whether the permission can access the Datasets resource.

Supported output formats:RJSON,JSON,XML.

Resource hierarchy

HTTP request methods

Perform an HTTP request on the following URI, using rjson output format as an example, where supermapiportal is the server name.

http://supermapiportal:8190/iportal/web/datas/{dataId}/datasets.rjson

GET request

Retrieves the dataset information contained in the data. Supports retrieving dataset information from udb, CSV, Excel, GeoJSON, and SuperMap workspace type data configured with relational storage, as well as dataset information from user-registered HDFS and HBase data.

Response structure

Performing a GET request on the dataDatasets resource. The response entity body contains the collection of all datasets in the current data. The structure of a single dataset description is as follows:

Field Type Description
name String The dataset name.
type String The dataset type.
metaInfo MetaInfo The metadata information.
fieldInfo List<FieldInfo> The collection of dataset field information.
recordCount int The number of records in the dataset.

Response example

Performing a GET request on the dataDatasets resource: http://localhost:8190/iportal/web/datas/640862503/datasets.rjson. The rjson format resource representation is as follows:

[

    {

        "metaInfo": null,

        "name": "dataExcel_764834992",

        "type": "POINT",

        "fieldInfo": null

    }

]

HEAD request

Returns the same HTTP response headers as a GET request, but without the response entity. Metadata information contained in the response headers can be obtained without transferring the entire response content. Metadata includes media type, character encoding, content encoding, and content length.

HEAD requests can be used to determine whether the dataDatasets resource exists or whether the client has permission to access the dataDatasets resource. By performing a HEAD request on a URI with .<format>, you can also quickly determine whether the dataDatasets resource supports the <format> format representation.

See