queryable


URI

<tempLayer_uri>/queryable[.<format>]

Supported methods

GET, PUT, HEAD

Parent resource

tempLayer

Introduction

As a child resource of the tempLayer resource, the queryable resource is used to identify if the temporary layer could be queried. You can modify the status of the layer by implementing the PUT request on the queryable resource.

Supported methods

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

GIS Services Resource Hierarchy

root maps map tempLayersSet tempLayers tempLayers queryable.htm

HTTP request methods

Implement the HTTP request on the following URI, where supermapiserver is the name of the server, WorldMap is the name of the map (mapName), 1 is the ID of a temporary layer set (tempLayersID) in WorldMap, Capitasl@world@@WorldMap represents the WorldMap sublayer in the temporary layer set, and you will get the representation of the queryable resource of the temporary layer in rjson format.

http://supermapiserver:8090/iserver/services/map-world/rest/maps/WorldMap/tempLayersSet/1/Capitals@World@@WorldMap/queryable.rjson

GET Request

Gets the representation about if the temporary layer is queryable. True indicates queryable. False indicates inqueryable.

Request parameters

Field Type Definition
_cache boolean [Optional parameters]
Whether to use cache, the default is True. False means close all the caches.

Response structure

A GET request is performed on the queryable resource, and a Boolean value is returned, indicating whether or not the layer can be queried. True indicates query.

Example of response

Implement the GET request on the queryable resource with http://supermapiserver:8090/iserver/services/map-world/rest/maps/WorldMap/tempLayersSet/1/Capitals@World@@WorldMap/queryable.rjson. The response is a boolean value, as shown below, indicating if the temporal layer Capitals@world could be queried.

true

PUT request

Modifies the query status of the layer.

Description

Request parameters

To implement the PUT request to modify the query status of the temporary layer, certain parameters must be included in the request body of the PUT. If the parameters are legitimate, the server will modify the query status of the layer according to the parameters.

Here the parameter in the request body is a boolean value that indicates if the layer could be queried.

Response structure

Implement the GET request on the queryable resource and you will get the respose structure as shown below (The representation is in the entity body of the response message):

Name Type Description
succeed boolean

Whether the modify query status of the temporary layer is successful. If not, there would be an error message.

error HttpError The error message. If the modification is successful, the field will be absent.

Example of response

Implement the PUT request on the queryable resource with http://supermapiserver:8090/iserver/services/map-world/rest/maps/WorldMap/tempLayersSet/1/Capitals@World@@WorldMap/queryable.rjson to change the query status of Capitals@world. The request body is as shown below.

false

If the modification is successful, you will get the response in rjson format as shown below.

{

    "succeed": true

}

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.

The HEAD request helps check the existence of the querable resource and whether it can be accessed by the client. By implementing the HEAD request on the URI, with .<format> appended to the end, we can quickly get to know whether queryable resource supports the representation in <format> or not.

See