修改数据集字段(field)

PUT

/rest/services/{servicename}/data/field

修改字段元数据信息，支持批量操作；针对多个字段的修改，有的可能成功，有的可能失败，不能回退；有一个成功，默认返回成功；风险较高，建议配合权限使用。

不建议修改字段类型，因为存储的数据类型如果与指定的不一样，可能会引起预想不到的问题，比如数据丢失等
请求示例

示例1

{
    "Request-Method": "PUT",
    "datasourceName": "china",
    "datasetName": "road",
    "fieldNames": [
        "oldFieldName1",
        "oldFieldName2"
    ],
    "fields": [
        "field object1",
        "field object2",
        "field object3"
    ]
}

示例2（fields 里面的字段信息里面可以添加 newName 作为需要修改字段的新名称）

{
    "Request-Method": "PUT",
    "datasourceName": "bug60096",
    "datasetName": "XZQ",
    "fieldNames": [ // 这里指定的才进行操作，如果未指定，则忽略fields里面的对象
        "E" // 原字段名称
    ],
    "fields": [
        {
            "name": "E", // 原字段名, 总需要指定，如果只要此一个，则不会进行任何操作
            // 下面必须有指定，如果没有的话不会做任何操作
            "type": "Double", // 类型，不建议修改，可能会导致数据丢失，可以不需要，不指定时维持原状
            "newName": "fieldE", // 可以不需要，当需要修改字段名时，新指定的字段名
            "alias": "字段E", // 新的别名，可以不需要，不指定时维持原状  
            "isRequired": true, // 可以不需要，不指定时维持原状
            "isNullable": true, // 可以不需要，不指定时维持原状
            "isEditable": true, // 可以不需要，不指定时维持原状
            "precision": 4 // 可以不需要，不指定时维持原状
            // 其他未指定的项均沿用旧的
        }
    ]
}

请求参数

Path 参数

servicename

string

必需

Body 参数application/json

Request-Method

string

必需

http请求方法PUT

datasourceName

string

数据源名称

必需

datasourceID

string

可选

资源ID ，和datasourceName功能相同，用于确定数据源。服务重启（持久化后再加载）保证一致性。二选一。

datasetID

string

可选

每个数据集对应一个唯一标识ID，可替换数据源名称+数据集名称确定一个唯一数据集。效果可数据源名称+数据集名称相同。二选一，优先级高。

datasetName

string

数据集名称。

必需

parentDatasetName

string

父数据集名称

可选

fieldNames

array[string]

必需

修改前的属性字段的名称，与下面fields的数组个数对应。

fields

object (Field)

必需

修改后的字段信息参数说明。

name

string

必需

字段名称。唯一标识一个字段，没有重名。

alias

string

必需

字段别名，不同的字段可以有相同的别名。

type

enum<string>

必需

字段类型。底层sdk字段类型eKQFieldType对应的字符串

枚举值:

UnknownInt8Int16Int32Int64FloatDoublestringDateBlobFIDGUIDXMLGeometryANSIString

length

string

字段长度。默认为0

可选

isNullable

boolean

是否可为空。

可选

isEditable

boolean

可选

是否可编辑。默认为true

isRequired

boolean

可选

是否为必填字段。true 表示是必填字段，false 表示非必填字段。

presicion

integer

字段精度。

可选

defaultValue

string

可选

字段的默认值。保持和底层默认值一致

isSystemField

boolean

可选

是否为系统字段, 保持和底层默认值一致，一般几何字段，ID字段才为必须字段

comment

string

字段注释。

可选

isGeoField

boolean

可选

是否为图形字段。默认为false

isRegisteredRenderIndex

boolean

可选

字段是否为渲染索引字段。默认为false

constraints

object (FieldConstraints)

可选

约束类型,参考FieldConstraints 结构体

domain

object (DomainInfo)

可选

属性域，参考属性域对象DomainInfo

connInfo

object (ConnectionInfo)

可选

【connInfo`对象】支持的对象数据源连接信息，动态打开数据源，功能和其他datasourceID和datasourceName、destDatasetName、datasetName等参数的组合类似，互斥关系，且优先级优先级高于其他组合。该参数用于全局通用数据服务，根据临时连接信息动态打开数据源或数据集。**

connecttype

string

必需

数据源类型，支持 Folder,RelationalDB_Access,KQSpatialDB,KQPostgisDB,RelationalDB_PostgreSQL,RelationalDB_Kingbase8,
RelationalDB_MySql,
RelationalDB_SQL,RelationalDB_OCI11,RelationalDB_DM,S57,GDB,GeoJSON,MongoDB

filepath

string

可选

文件路径，当数据源为文件或文件目录时有效，数据源类型为Folder,RelationalDB_Access,KQSpatialDB为文件型数据源。

server

string

可选

数据库服务器地址(IP或机器名)

instance

string

可选

数据库实例名或端口

database

string

数据库名称

可选

user

string

数据源用户名

可选

password

string

数据库密码

可选

dataset_name

string

表名

可选

示例

{
    "Request-Method": "PUT",
    "datasourceName": "china",
    "datasetName": "road",
    "fieldNames": [
        "oldFieldName1",
        "oldFieldName2"
    ], // 修改前的属性字段的名称，与下面fields的数组个数对应
    "fields": [
        field object1,
        field object2,
        field object3
    ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT '/rest/services//data/field' \
--header 'Content-Type: application/json' \
--data-raw '{
    "Request-Method": "PUT",
    "datasourceName": "china",
    "datasetName": "road",
    "fieldNames": [
        "oldFieldName1",
        "oldFieldName2"
    ], // 修改前的属性字段的名称，与下面fields的数组个数对应
    "fields": [
        field object1,
        field object2,
        field object3
    ]
}'

返回响应

🟢200成功

application/json

Body

resultcode

string

必需

示例

成功示例部分成功的情况下，包含result,并且里面有某个字段错误原因失败情况

{
    "resultcode": "success",    //返回结果代码，”success”表示成功，”error”表示失败， "partSuccess"部分成功
     "result": {
        "successResult":true // 没有失败的
    }
}

修改于 2024-08-09 03:05:32

添加字段(field)

删除字段(field)