field

URI

<fields_uri>/{fieldName}[.<format>]

支持的方法

GET、HEAD

父资源

fields

介绍

 field 资源表示一个数据集中的一个字段。如 URI 中所示，使用 {fieldName}来访问一个字段 。

支持的方法：

支持的表述格式：RJSON、JSON、HTML、XML。

资源层次

HTTP 请求方法

对如下 URI 执行 HTTP 请求，以 rjson 输出格式为例加以说明，其中，supermapiserver 是服务器名。

http://supermapiserver:8090/iserver/services/datacatalog/sharefile/datasets/{datasetName}/fileds/{filedName}.rjson

GET 请求

获取字段信息。字段的信息包括：字段名称，字段类型，字段别名，字段默认值，字段是否允许为空，字段最大长度，是否允许长度为零等。

响应结构

对 field 资源执行 GET 请求，可以获得字段信息 fieldInfo，表述结构如下：

字段 类型 说明
name String 字段名称。唯一标识一个字段，没有重名。
caption String 字段别名，不同的字段可以有相同的别名。
type FieldType 字段类型。
defaultValue String 字段的默认值。
isRequired boolean 是否为必填字段。true 表示是必填字段，false 表示非必填字段。
isSystemField boolean 是否为 SuperMap 系统字段，true 表示是 SuperMap 系统字段。
SuperMap 系统字段是以 SM 为前缀的字段，SMUserID 除外。
isZeroLengthAllowed boolean 是否允许零长度。
maxLength int 字段的最大长度。

响应示例

对示例 field 资源：http://supermapiserver:8090/iserver/services/datacatalog/rest/datacatalog/sharefile/samples_processing_singleRegion_R/fields/SmID.rjson 执行 GET 请求，获取 samples_processing_singleRegion_R 数据集中SmID 字段的 rjson 格式的表述如下：

{

  "childUriList": null,

  "fieldInfo": {

    "caption": "SmID",

    "defaultValue": "",

    "isRequired": true,

    "isSystemField": true,

    "isZeroLengthAllowed": true,

    "maxLength": 4,

    "name": "SmID",

    "type": "INT32"

  }

}

HEAD 请求

返回跟 GET 请求一样的 HTTP 响应头，但是没有响应实体。可以在不必传输整个响应内容的情况下，获取包含在响应消息头中的元数据信息。元数据信息包括媒体类型，字符编码，压缩编码，实体内容长度等。

HEAD 请求可以用来判断 field 资源是否存在，或者客户端是否有权限访问 field 资源。通过对加.<format>的 URI 执行 HEAD 请求，还可以快速判断 field 资源是否支持<format>格式的表述。

请参见