sharefile


URI

<datacatalog_uri>/sharefile[.<format>]

Supported methods

GET, HEAD

Parent resource

datacatalog

Child resources

dataset

Introduction

The sharefile resource represents a collection of datasets registered to iServer. By executing a GET request on the sharefile resource, you can get all the datasets registered with iServer, including the csv data file, and the dataset contained in the registered datasource (* .udb, udd).

Supported Methods:

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.rjson

GET request

Get all datasets registered to iServer.

Response structure

The GET request is executed on the sharefile resource, which returns all the datasets information in the datasource. The structure of the resource expression is as follows:

Field Type Description
datasetCount int The number of datasets contained in the sharefile resource.
datasetsNames List<String> A list of the names of the datasets.
childUriList List<String> The access path of the dataset (that is, the URI of the dataset resource).

Response example

The returned rjson format representation after implementing the GET request on the sharefile resource http://supermapiserver:8090/iserver/services/datacatalog/rest/datacatalog/sharefile.rjson is as follows:

{

  "childUriList": [

    "http://supermapiserver:8090/iserver/services/datacatalog/rest/datacatalog/sharefile/d1_newyork_taxi_2013_01_14k_new",

    "http://supermapiserver:8090/iserver/services/datacatalog/rest/datacatalog/sharefile/d2_World_Ocean",

    "http://supermapiserver:8090/iserver/services/datacatalog/rest/datacatalog/sharefile/d2_World_Ocean_Label",

    "http://supermapiserver:8090/iserver/services/datacatalog/rest/datacatalog/sharefile/d2_World_Country_Label",

    "http://supermapiserver:8090/iserver/services/datacatalog/rest/datacatalog/sharefile/d2_World_Continent_Label",

    "http://supermapiserver:8090/iserver/services/datacatalog/rest/datacatalog/sharefile/d2_World_Lakes",

    "http://supermapiserver:8090/iserver/services/datacatalog/rest/datacatalog/sharefile/d2_World_Rivers",

    "http://supermapiserver:8090/iserver/services/datacatalog/rest/datacatalog/sharefile/d2_World_Grids",

    "http://supermapiserver:8090/iserver/services/datacatalog/rest/datacatalog/sharefile/d2_World_continent_T",

    "http://supermapiserver:8090/iserver/services/datacatalog/rest/datacatalog/sharefile/d2_World_Ocean_Label_1",

    "http://supermapiserver:8090/iserver/services/datacatalog/rest/datacatalog/sharefile/d2_World_Countries",

    "http://supermapiserver:8090/iserver/services/datacatalog/rest/datacatalog/sharefile/d2_World_Capitals",

    "http://supermapiserver:8090/iserver/services/datacatalog/rest/datacatalog/sharefile/d2_World_OceanLabel",

    "http://supermapiserver:8090/iserver/services/datacatalog/rest/datacatalog/sharefile/d2_World_CountryLabel1",

    "http://supermapiserver:8090/iserver/services/datacatalog/rest/datacatalog/sharefile/d2_World_CountryLabel"

  ],

  "datasetCount": 15,

  "datasetNames": [

    "d1_newyork_taxi_2013_01_14k_new",

    "d2_World_Ocean",

    "d2_World_Ocean_Label",

    "d2_World_Country_Label",

    "d2_World_Continent_Label",

    "d2_World_Lakes",

    "d2_World_Rivers",

    "d2_World_Grids",

    "d2_World_continent_T",

    "d2_World_Ocean_Label_1",

    "d2_World_Countries",

    "d2_World_Capitals",

    "d2_World_OceanLabel",

    "d2_World_CountryLabel1",

    "d2_World_CountryLabel"

  ]

}

HEAD request

Returns the same HTTP response header as the GET request, but does not have the response entity. It can get the metadata information in the response header without transferring the whole response content. Metadata information includes media type, character encoding, compression encoding, entity content length, and so on.

The HEAD request can be used to determine whether the sharefile resource exists or whether the client has authority to access the resource. It can quickly determine whether the sharefile resource supports the representation in <format> format by performing HEAD request on URI with <format>.

See