config


URI

/config.{fileExtension}

Supported methods

GET, HEAD

Parent resource

data

Introduction

The config resource is used to retrieve the configuration file of a 3D dataset through performing a GET request. The "level" parameter must also be included in the URI if the 3D dataset is cached 3D model data (SGM data), as there is a data configuration file for every cache level for model data. Note that the configuration files are different for different types of 3D datasets. Hence the specific output format of the config resource depends on the type of the 3D data. When the configuration file is retrieved, the output format is the same as the extension of the configuration file for that type of 3D data. They can also be empty, in which case the corresponding configuration file is returned by default.

For information about the types of 3D datasets, please refer to JavaDoc:RealspaceDataType .

Note: Data in KML format do not have any configuration files. Thus if the 3D dataset is of KML type, the KML dataset itself will be retrieved instead by the config resource.

Supported methods

Supported output formats: The output format of a config resource is the file extension of the configuration file of the 3D data (dataName), thus is different for different types of 3D data. The data types and their corresponding configuration file formats are listed below:

3D dataset type Configuration file extension
Cached image data

sci3d

TCached terrain data sct
Cached 3D model data scv
KML data kml, kmz

 

GIS Services Resource Hierarchy

root realspace datas data config

HTTP request methods

Below is an example of performing an HTTP request on a URI with a cached 3D model dataset. In the URI: supermapiserver is the name of the server; OlympicGreen is the name of the cached 3D model dataset; and SCV is the corresponding output format for cached 3D model data.

http://supermapiserver:8090/iserver/services/3D-sample/rest/realspace/datas/OlympicGreen/config.scv

GET Request

Gets the configuration file of a 3D dataset.

Request parameters

A number of parameters can be included in the URI when performing a GET request on the config resource. The parameters passed before "?" are as follows:

Field Type Definition
fileExtension String The extension of the configuration file of the 3D dataset. If
it is empty, then the configuration file (although without any extension) corresponding to the 3D dataset is returned by default.
_cache boolean [Optional parameters]
Whether to use cache, the default is True. False means close all the cache.

Response structure

Performing a GET request on the config resource returns the configuration file corresponding to the 3D dataset. The returned configuration file can be saved and used by clients.

Example usage

In the following example, a GET request is performed on an example config resource with cached model dataset OlympicGreen  :

http://supermapiserver:8090/iserver/services/3D-sample/rest/realspace/datas/OlympicGreen/config.scv

The configuration file (config) of cached model dataset OlympicGreen is returned.

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 written 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 if the config resource exists, or if the resouce can be accessed by clients. It can also determine if the config resource supports output format fileExtension if performed on a URI with .fileExtension included.

See