dataset

URI

<sharefile_uri>/{datasetName}[.<format>]

Supported methods

Parent resource

Introduction

The dataset resource represents a dataset. By sending GET request to dataset resource to get the description information of this dataset.

Supported Methods:

GET: Gets the detail information of dataset.
HEAD: Checks whether the dataset resource exists or whether there is a permission to access the resource.

Supported output formats: rjson, json, html, xml.

Resource hierarchy

HTTP request methods

Implement the HTTP request on the following URI, where supermapiserver is the server name, with rjson being the output format.

http://supermapiserver:8090/iserver/services/datacatalog/rest/datacatalog/sharefile/d2_World_Capitals.rjson

GET request

Gets the detail information of dataset.

Response structure

The structure of the response resource representation after implementing the GET request on the dataset resource will be as follows:

Field	Type	Description
bounds	String	dataset bounds. This parameter will be returned when data file is "UDB".
datasetName	String	Dataset name. This parameter will be returned when data file is "UDB".
datasetType	DatasetType	Dataset type. This parameter will be returned when data file is "UDB".
epsgCode	int	Projected coordinate system of dataset. This parameter will be returned when data file is "UDB".
name	String	Data name. The dataset will be renamed when successfully registered in iServer. The structure of name is like "storageID_datasourceName_datasetName".
readOnly	boolean	Whether the dataset is readonly. This parameter will be returned when data file is "UDB".
type	BigDataFileShareDatasetInfoType	Data file type. including CSV and UDB data.
url	String	The storage path of data file.
xIndex	int	X index. iServer will get all data in x direction by xIndex. This parameter will be returned when data file is "CSV".
yIndex	int	Y index. iServer will get all data in x direction by yIndex. This parameter will be returned when data file is "CSV".
separator	String	CSV file separator. This parameter will be returned when data file is "CSV".

Response example

Execute GET request to dataset resource: http://supermapiserver:8090/iserver/services/datacatalog/rest/datacatalog/sharefile/d2_World_Capitals.rjson. The representation of returned World_Capitals dataset(which is DatasetVector):

{

"bounds": "Left=-175.24565064968198,Bottom=-41.33484005165742,Right=179.22188736363634,Top=64.13499891788544",

"datasetName": "Capitals",

"datasetType": "POINT",

"epsgCode": 4326,

"name": "d2_World_Capitals",

"readOnly": false,

"type": "UDB",

"url": "E:\\supermap_packages\\data\\World\\World.udb"

}

HEAD request

Asks for the response identical to the one that would correspond to a GET request, but without the response body. This is useful for retrieving meta-information contained in response headers, without having to transport the entire content. The meta-information includes the media-type, content-encoding, transfer-encoding, content-length, etc.

HEAD request can be used to check whether the dataset resource exists, or whether the the client has the permission to access it. It can also determine if the dataset resource supports an output format <format> if performed on a URI with .<format> included.