字段操作

工作表字段的唯一标识是字段名称和工字段ID，可通过表结构查看获取。

添加字段

向已有工作表中添加新字段。

• 目前支持字段类型为:
  • string
  • date
  • number
• uniq_index为主键索引，0不是主键，1为主键；

请求URL：

https://open.bdp.cn/api/field/add

请求方式：GET

请求参数说明：

QueryString：

参数名称	参数类型	是否必填	默认值	参数描述	最大长度
access_token	string	必填	无	开发者中心获取token，用来作为用户的身份认证	未限制
tb_id	string	必填	无	字段名	256
type	string	可选	无	字段类型，只能是number，string，date，区分大小写，必须是小写	未限制
uniq_index	int	可选	0	是否作为去重字段，0不是 1是	未限制
title	string	可选	无	字段别名	256
remark	string	可选	无	字段备注	256

请求示例：

curl --request GET   --url 'https://open.bdp.cn/api/field/add?access_token=19de5e0297bfd55097733dfbc87ad79e&tb_id=tb_cc8bea1e64fb4794976eafd1d6546512&name=new_field&
type=string&uniq_index=0&title=title_of_field&remark=remark_of_field'

请求成功时返回说明示例：

{
    "status": 0,
    "errstr": "",
    "result": "success"
}

请求失败时返回说明示例：

{
    "status": 6,
    "errstr": "error message"
}

错误代码说明：

status	errstr
6	字段名已存在
6	字段类型不合法
501	内部错误（添加字段）

查询工作表字段信息

查看工作表的详细结构，可以查看字段ID。

请求URL：

https://open.bdp.cn/api/field/list

请求方式：GET

请求参数说明：

QueryString：

参数名称	参数类型	是否必填	默认值	参数描述	最大长度
access_token	string	必填	无	开发者中心获取token，用来作为用户的身份认证	未限制
tb_id	string	必填	无	工作表id	256

请求示例：

curl --request GET --url 'https://open.bdp.cn/api/field/list?access_token=19de5e0297bfd55097733dfbc87ad79e&tb_id=tb_cc8bea1e64fb4794976eafd1d6546512'

请求成功时返回说明示例：

{
    "status": 0,
    "errstr": "",
    "result": [                         //工作表结构
        {
            "name": "id",               //字段名称
            "field_id": "fk1713683a",           //字段ID
            "uniq_index": 0,                   //唯一键值标记
            "type": "string"                   //字段类型
        },
        {
            "name": "name",
        "field_id": "fk44d9a111",
            "uniq_index": 0,
            "type": "date"
        },
        {
            "name": "birth",
            "field_id": "fk8967485c",
            "uniq_index": 0,
            "type": "number"
        }
    ]
}

请求失败时返回说明示例：

{
    "status": 0,
    "errstr": ""
}

错误代码说明：

status	errstr
503	内部错误（表结构查看）

修改工作表字段属性

可以修改字段的类型和索引属性。修改主键索引可能会引起数据变动，结果将根据新主键索引去重，请谨慎使用。

请求URL：

https://open.bdp.cn/api/field/modify

请求方式：GET

请求参数说明：

QueryString：

参数名称	参数类型	是否必填	默认值	参数描述	最大长度
access_token	string	必填	无	开发者中心获取token，用来作为用户的身份认证	未限制
tb_id	string	必填	无	工作表id	256
type	string	可选	无	字段类型，只能是number，string，date，区分大小写，必须是小写	未限制
uniq_index	int	可选	0	是否作为去重字段，0不是 1是	未限制
title	string	可选	无	字段别名	256
remark	string	可选	无	字段备注	256

请求示例：

curl --request GET   --url 'https://open.bdp.cn/api/field/modify?access_token=19de5e0297bfd55097733dfbc87ad79e&tb_id=tb_cc8bea1e64fb4794976eafd1d6546512&
name=new_field&type=string&uniq_index=0&title=title_of_field&remark=remark_of_field'

请求成功时返回说明示例：

{
    "status": 0,
    "errstr": "",
    "result": "success"
}

请求失败时返回说明示例：

{
    "status": 6,
    "errstr": "error message"
}

错误代码说明：

status	errstr
6	字段名已存在
6	字段类型不合法
6	字段名错误，没有该字段
6	不支持对当前字段进行索引
504	内部错误（修改字段）

删除工作表字段

强制删除已有工作表中的字段，会导致引用到该字段的图表实效。

请求URL：

https://open.bdp.cn/api/field/delete

请求方式：GET

请求参数说明：

QueryString：

参数名称	参数类型	是否必填	默认值	参数描述	最大长度
access_token	string	必填	无	开发者中心获取token，用来作为用户的身份认证	未限制
tb_id	string	必填	无	工作表id	256
name	string	必填	无	字段名	未限制

请求示例：

curl --request GET   --url 'https://open.bdp.cn/api/field/modify?access_token=19de5e0297bfd55097733dfbc87ad79e&tb_id=tb_cc8bea1e64fb4794976eafd1d6546512&name=new_field&
type=string&uniq_index=0&title=title_of_field&remark=remark_of_field'

请求成功时返回说明示例：

{
    "status": 0,
    "errstr": "",
    "result": "success"
}

请求失败时返回说明示例：

{
    "status": 6,
    "errstr": "error message"
}

错误代码说明：

status	errstr
6	字段名错误，没有该字段
403	字段被其他工作表使用中，不能删除
501	内部错误（删除字段）
503	内部错误（删除字段）