URI

<vectorMap_uri>/v2/datas[.<format>]

Supported Methods

GETHEAD

Parent Resource

vectorMap

Introduction

List of data used in the Vectortiles Service V2, including field information of the data and layer information corresponding to the data. When accessed in HTML format, it provides iClient for MapboxGL with MVT representation to browse each data.

Supported Methods:

  • GET: Retrieves the data used in the Vectortiles Service V2 and its corresponding layer information.
  • HEAD: Checks whether the datas resource exists and whether the permission is accessible.

Supported Representation Formats: RJSON, JSON, JSONP, HTML.

HTTP Request Methods

Perform an HTTP request on the following URI, using JSON output format as an example. Among them, supermapiserver is the server name, {component} is the component name, and {serverName} is the "service name" defined during service publishing.

http://supermapiserver:8090/iserver/services/vectorMap-DLTB-public/restjsr/v2/datas.json

GET Request

Retrieves the list of data used in the vector tiles service V2 and its information, including field information of the data and layer information corresponding to the data, etc.

Response Structure

The structure of the resource representation returned by performing a GET request on the datas resource is as follows:  

Field Type Description
idField string Unique identifier field name of layer features
database string Database name to which the data belongs
beginLevel int Starting display zoom level of the layer
bounds Rectangle2D Visible geographic extent of the layer
dataName string Dataset name
hasLabel null/boolean Whether to enable the label layer
id string Unique ID of the layer
isVisible boolean Whether the layer is visible by default; false means hidden by default
fields array[] Collection of layer attribute field configurations
endLevel number Ending display zoom level of the layer
geometryType string Geometry type of features
labelField string Field name used for labels

Response Structure of fields

Field Type Description
isRequired boolean Whether the field is required
defaultValue string Default value of the field
name string Field name
caption string Field display alias
type string Field data type
maxLength int Maximum length of the field; -1 indicates no limit
isZeroLengthAllowed boolean Whether to allow empty strings
isSystemField boolean Whether it is a system built-in field (such as smid, smarea, etc.)

Response Example

Perform a GET request on the datas resource: http://supermapiserver:8090/iserver/services/vectorMap-DLTB-public/restjsr/v2/datas.json, and the returned resource representation in JSON format is as follows:

[
  {
    "idField": "smid",
    "database": "DLTB",
    "beginLevel": 1,
    "bounds": {
      "top": 23.48064438917779,
      "left": 109.41607750300243,
      "bottom": 22.617793848072214,
      "leftBottom": {
        "x": 109.41607750300243,
        "y": 22.617793848072214,
        "m": null
      },
      "right": 110.47650761500358,
      "rightTop": {
        "x": 110.47650761500358,
        "y": 23.48064438917779,
        "m": null
      }
    },
    "dataName": "dltb40w_4326",
    "hasLabel": null,
    "id": null,
    "isVisible": false,
    "fields": [
      {
        "isRequired": true,
        "defaultValue": "nextval('dltb40w_4326_smid_seq'::regclass)",
        "name": "SmID",
        "caption": "SmID",
        "type": "INT32",
        "maxLength": 4,
        "isZeroLengthAllowed": false,
        "isSystemField": true
      },
      {
        "isRequired": true,
        "defaultValue": "0",
        "name": "smuserid",
        "caption": "smuserid",
        "type": "INT32",
        "maxLength": 4,
        "isZeroLengthAllowed": false,
        "isSystemField": false
      },
      {
        "isRequired": true,
        "defaultValue": "0.0",
        "name": "smarea",
        "caption": "smarea",
        "type": "DOUBLE",
        "maxLength": 8,
        "isZeroLengthAllowed": false,
        "isSystemField": true
      },
      {
        "isRequired": true,
        "defaultValue": "0.0",
        "name": "smperimeter",
        "caption": "smperimeter",
        "type": "DOUBLE",
        "maxLength": 8,
        "isZeroLengthAllowed": false,
        "isSystemField": true
      },
      {
        "isRequired": false,
        "defaultValue": "",
        "name": "smgeometry",
        "caption": "smgeometry",
        "type": "LONGBINARY",
        "maxLength": -1,
        "isZeroLengthAllowed": false,
        "isSystemField": true
      },
      {
        "isRequired": false,
        "defaultValue": "",
        "name": "smgeoparam",
        "caption": "smgeoparam",
        "type": "LONGBINARY",
        "maxLength": -1,
        "isZeroLengthAllowed": false,
        "isSystemField": true
      },
      {
        "isRequired": false,
        "defaultValue": "",
        "name": "bsm",
        "caption": "bsm",
        "type": "INT32",
        "maxLength": 4,
        "isZeroLengthAllowed": false,
        "isSystemField": false
      },
      {
        "isRequired": false,
        "defaultValue": "",
        "name": "ysdm",
        "caption": "ysdm",
        "type": "WTEXT",
        "maxLength": 10,
        "isZeroLengthAllowed": true,
        "isSystemField": false
      },
      {
        "isRequired": false,
        "defaultValue": "",
        "name": "tbybh",
        "caption": "tbybh",
        "type": "WTEXT",
        "maxLength": 8,
        "isZeroLengthAllowed": true,
        "isSystemField": false
      },
      {
        "isRequired": false,
        "defaultValue": "",
        "name": "tbbh",
        "caption": "tbbh",
        "type": "WTEXT",
        "maxLength": 8,
        "isZeroLengthAllowed": true,
        "isSystemField": false
      },
      {
        "isRequired": false,
        "defaultValue": "",
        "name": "dlbm",
        "caption": "dlbm",
        "type": "WTEXT",
        "maxLength": 4,
        "isZeroLengthAllowed": true,
        "isSystemField": false
      },
      {
        "isRequired": false,
        "defaultValue": "",
        "name": "dlmc",
        "caption": "dlmc",
        "type": "WTEXT",
        "maxLength": 60,
        "isZeroLengthAllowed": true,
        "isSystemField": false
      },
      {
        "isRequired": false,
        "defaultValue": "",
        "name": "qsxz",
        "caption": "qsxz",
        "type": "WTEXT",
        "maxLength": 3,
        "isZeroLengthAllowed": true,
        "isSystemField": false
      },
      {
        "isRequired": false,
        "defaultValue": "",
        "name": "qsdwdm",
        "caption": "qsdwdm",
        "type": "WTEXT",
        "maxLength": 19,
        "isZeroLengthAllowed": true,
        "isSystemField": false
      },
      {
        "isRequired": false,
        "defaultValue": "",
        "name": "qsdwmc",
        "caption": "qsdwmc",
        "type": "WTEXT",
        "maxLength": 60,
        "isZeroLengthAllowed": true,
        "isSystemField": false
      },
      {
        "isRequired": false,
        "defaultValue": "",
        "name": "zldwdm",
        "caption": "zldwdm",
        "type": "WTEXT",
        "maxLength": 19,
        "isZeroLengthAllowed": true,
        "isSystemField": false
      },
      {
        "isRequired": false,
        "defaultValue": "",
        "name": "zldwmc",
        "caption": "zldwmc",
        "type": "WTEXT",
        "maxLength": 60,
        "isZeroLengthAllowed": true,
        "isSystemField": false
      },
      {
        "isRequired": false,
        "defaultValue": "",
        "name": "gdlx",
        "caption": "gdlx",
        "type": "WTEXT",
        "maxLength": 2,
        "isZeroLengthAllowed": true,
        "isSystemField": false
      },
      {
        "isRequired": false,
        "defaultValue": "",
        "name": "kclx",
        "caption": "kclx",
        "type": "WTEXT",
        "maxLength": 2,
        "isZeroLengthAllowed": true,
        "isSystemField": false
      },
      {
        "isRequired": false,
        "defaultValue": "",
        "name": "dlbz",
        "caption": "dlbz",
        "type": "WTEXT",
        "maxLength": 2,
        "isZeroLengthAllowed": true,
        "isSystemField": false
      },
      {
        "isRequired": false,
        "defaultValue": "",
        "name": "gdpdj",
        "caption": "gdpdj",
        "type": "WTEXT",
        "maxLength": 2,
        "isZeroLengthAllowed": true,
        "isSystemField": false
      },
      {
        "isRequired": false,
        "defaultValue": "",
        "name": "kcdlbm",
        "caption": "kcdlbm",
        "type": "WTEXT",
        "maxLength": 4,
        "isZeroLengthAllowed": true,
        "isSystemField": false
      },
      {
        "isRequired": false,
        "defaultValue": "",
        "name": "tkxs",
        "caption": "tkxs",
        "type": "DOUBLE",
        "maxLength": 8,
        "isZeroLengthAllowed": false,
        "isSystemField": false
      },
      {
        "isRequired": false,
        "defaultValue": "",
        "name": "tbmj",
        "caption": "tbmj",
        "type": "DOUBLE",
        "maxLength": 8,
        "isZeroLengthAllowed": false,
        "isSystemField": false
      },
      {
        "isRequired": false,
        "defaultValue": "",
        "name": "xzdwmj",
        "caption": "xzdwmj",
        "type": "DOUBLE",
        "maxLength": 8,
        "isZeroLengthAllowed": false,
        "isSystemField": false
      },
      {
        "isRequired": false,
        "defaultValue": "",
        "name": "lxdwmj",
        "caption": "lxdwmj",
        "type": "DOUBLE",
        "maxLength": 8,
        "isZeroLengthAllowed": false,
        "isSystemField": false
      },
      {
        "isRequired": false,
        "defaultValue": "",
        "name": "tkmj",
        "caption": "tkmj",
        "type": "DOUBLE",
        "maxLength": 8,
        "isZeroLengthAllowed": false,
        "isSystemField": false
      },
      {
        "isRequired": false,
        "defaultValue": "",
        "name": "tbdlmj",
        "caption": "tbdlmj",
        "type": "DOUBLE",
        "maxLength": 8,
        "isZeroLengthAllowed": false,
        "isSystemField": false
      },
      {
        "isRequired": false,
        "defaultValue": "",
        "name": "pzwh",
        "caption": "pzwh",
        "type": "WTEXT",
        "maxLength": 50,
        "isZeroLengthAllowed": true,
        "isSystemField": false
      },
      {
        "isRequired": false,
        "defaultValue": "",
        "name": "bgjlh",
        "caption": "bgjlh",
        "type": "WTEXT",
        "maxLength": 20,
        "isZeroLengthAllowed": true,
        "isSystemField": false
      },
      {
        "isRequired": false,
        "defaultValue": "",
        "name": "bgrq",
        "caption": "bgrq",
        "type": "DATETIME",
        "maxLength": 8,
        "isZeroLengthAllowed": false,
        "isSystemField": false
      },
      {
        "isRequired": false,
        "defaultValue": "",
        "name": "shape_leng",
        "caption": "shape_leng",
        "type": "DOUBLE",
        "maxLength": 8,
        "isZeroLengthAllowed": false,
        "isSystemField": false
      },
      {
        "isRequired": false,
        "defaultValue": "",
        "name": "shape_area",
        "caption": "shape_area",
        "type": "DOUBLE",
        "maxLength": 8,
        "isZeroLengthAllowed": false,
        "isSystemField": false
      }
    ],
    "endLevel": 24,
    "geometryType": "REGION",
    "labelField": null
  }
]

HEAD Request

Returns the same HTTP response headers as the GET request, but without the response entity. Metadata information contained in the response message headers (such as media type, character encoding, compression encoding, entity content length, etc.) can be obtained without transmitting the entire response content.

The HEAD request can be used to determine whether the datas resource exists or whether the client has permission to access the datas resource. By executing a HEAD request on a URI with .<format>, it can also quickly determine whether the datas resource supports the representation in the <format> format.

Related Topics