URI

<dataDatasets_uri>/{name}[.<format>]

Supported methods

GET,HEAD

Parent resource

dataDatasets

Introduction

The dataDatasetInfo resource contains detailed information of a dataset.

Supported methods:

  • GET:Retrieves detailed information about a specified dataset.
  • HEAD: Checks whether the dataDatasetInfo resource exists or whether the permission can access the dataDatasetInfo resource.

Supported output formats:RJSON,JSON,HTML,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/{name}.rjson

GET request

Retrieves the detailed information of a specified dataset. 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 data.

Response structure

Performing a GET request on the dataDatasetInfo resource, the returned resource representation structure 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 dataDatasetInfo resource to retrieve dataset details. The rjson format response is as follows:

{

    "metaInfo": null,

    "recordCount": null,

    "name": "weibo_1550715974009_beijingWeibo",

    "type": null,

    "fieldInfo": [

        {

            "name": "col0",

            "type": "INT32"

        },

        {

            "name": "col1",

            "type": "INT32"

        },

        {

            "name": "col2",

            "type": "INT32"

        },

        {

            "name": "X",

            "type": "DOUBLE"

        },

        {

            "name": "Y",

            "type": "DOUBLE"

        }

    ]

}

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 dataDatasetInfo resource exists or whether the client has permission to access the dataDatasetInfo resource. By performing a HEAD request on a URI with .<format>, you can also quickly determine whether the dataDatasetInfo resource supports the <format> format representation.

See