更新数据集字段注释

POST

/public-api/data-source/{dsId}/update-annotation

接口简介

通过指定数据集，更新数据集字段注释

请求参数

Path 参数

dsId

string

数据集ID

必需

Header 参数

X-Auth-Token

string

个人Token

必需

Body 参数application/json

columns

array [object {2}]

字段列表

必需

fdId

string

字段ID

必需

annotation

string

字段注释

必需

最多200个字符，超过会截取

示例

{
    "columns": [
        {
            "fdId": "string",
            "annotation": "string"
        }
    ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/public-api/data-source//update-annotation' \
--header 'X-Auth-Token;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "columns": [
        {
            "fdId": "string",
            "annotation": "string"
        }
    ]
}'

返回响应

🟢200成功

application/json

Body

result

string

请求状态

必需

枚举值: ok、fail

response

响应结果

可选

示例

{
    "result": "ok",
    "response": "No columns change"
}

修改于 2025-07-16 03:18:58

创建数据集

触发数据集读取数据文件并更新