获取数据表字段信息
查询并返回当前低代码应用指定表下所有创建的字段列表
请求说明
| 请求地址 | https://openapi.wps.cn/v7/low_code_app/app_instance/{app_instance_id}/table/{table_id}/fields |
|---|---|
| 请求方法 | GET |
| 签名方式 | KSO-1 |
| 权限要求 | 查询低代码应用数据（应用授权） kso.low_code_app.read读写低代码应用数据（应用授权） kso.low_code_app.readwrite |
请求头（Header）
| Header 名称 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| Content-Type | string | 是 | 使用：application/json |
| X-Kso-Date | string | 是 | RFC1123 格式的日期，例: Wed, 23 Jan 2013 06:43:08 GMT |
| X-Kso-Authorization | string | 是 | KSO-1 签名值，详见《签名方法》 |
| Authorization | string | 是 | 授权凭证，格式为：Bearer {access_token} |
路径参数（Path）
| 名称 | 参数类型 | 说明 |
|---|---|---|
| app_instance_id | string | |
| table_id | string |
请求地址示例
[GET] https://openapi.wps.cn/v7/low_code_app/app_instance/{app_instance_id}/table/{table_id}/fields响应体
| 名称 | 参数类型 | 说明 |
|---|---|---|
| code | integer | 响应代码。非 0 表示失败，参照《状态码说明》 |
| msg | string | 响应信息 |
| data | object | 响应数据 |
| ∟ items | array[object] | |
| ∟ ∟ id | string | 字段 id |
| ∟ ∟ name | string | 字段名称 |
| ∟ ∟ nullable | boolean | 字段值是否必填 |
| ∟ ∟ setting | object | 字段设置，具体返回参见枚举对象 |
| ∟ ∟ ∟ accept_types | string | 支持附件类型 |
| ∟ ∟ ∟ allow_multi_parent | boolean | 允许多个父对象 |
| ∟ ∟ ∟ allow_negative | boolean | 允许负数 |
| ∟ ∟ ∟ allow_negative | boolean | 允许负数 |
| ∟ ∟ ∟ card_field_list | array[string] | 卡片展示字段列表 |
| ∟ ∟ ∟ card_field_list | array[string] | 卡片展示字段列表 |
| ∟ ∟ ∟ card_field_list | array[string] | 卡片展示字段列表 |
| ∟ ∟ ∟ card_order_by_list | array[object] | 卡片排序对象 |
| ∟ ∟ ∟ ∟ field | string | 排序字段 id |
| ∟ ∟ ∟ ∟ is_name | boolean | 显示名称 |
| ∟ ∟ ∟ ∟ type | string | 升序排、降序排 |
| ∟ ∟ ∟ category_tree | array[object] | 分类树对象数组 |
| ∟ ∟ ∟ ∟ children | array[object] | 分类树子对象 |
| ∟ ∟ ∟ ∟ color | string | 分类树背景色 |
| ∟ ∟ ∟ ∟ id | string | 分类树 id |
| ∟ ∟ ∟ ∟ name | string | 分类树名称 |
| ∟ ∟ ∟ children_fieldId | string | 子字段 id |
| ∟ ∟ ∟ color | string | 颜色 |
| ∟ ∟ ∟ color | string | 颜色 |
| ∟ ∟ ∟ count | integer | 数量 |
| ∟ ∟ ∟ default_value | string | 默认值 |
| ∟ ∟ ∟ default_value | string | 默认值 |
| ∟ ∟ ∟ default_value | string | 默认值为 |
| ∟ ∟ ∟ default_value | string | 默认值 |
| ∟ ∟ ∟ default_value | string | 默认值 |
| ∟ ∟ ∟ default_value | string | 默认值 |
| ∟ ∟ ∟ default_value | string | 默认值 |
| ∟ ∟ ∟ default_value | string | 默认值 |
| ∟ ∟ ∟ depends_list | array[object] | 依赖规则数组 |
| ∟ ∟ ∟ ∟ field_id | string | 依赖字段 id |
| ∟ ∟ ∟ ∟ id | string | 依赖字段 id |
| ∟ ∟ ∟ ∟ rule | string | 聚合函数 |
| ∟ ∟ ∟ disable_show_detail | boolean | 禁用展示详情 |
| ∟ ∟ ∟ display_width | integer | 签名展示宽度 |
| ∟ ∟ ∟ editable | boolean | 是否可编辑 |
| ∟ ∟ ∟ editable | boolean | 允许编辑 |
| ∟ ∟ ∟ editor_type | string | 编辑器类型，包括富文本编辑器、文本编辑器、代码编辑器和 Markdown 编辑器 |
| ∟ ∟ ∟ editor_type | string | 展示样式 |
| ∟ ∟ ∟ enable_binding_source | boolean | 是否启用绑定来源 |
| ∟ ∟ ∟ enable_range | boolean | 限定取值范围 |
| ∟ ∟ ∟ enable_range | boolean | 限定取值范围 |
| ∟ ∟ ∟ exportable | boolean | 允许导出 |
| ∟ ∟ ∟ field_id | string | 字段 id |
| ∟ ∟ ∟ field_id | string | 查找表字段 id |
| ∟ ∟ ∟ filter | object | 过滤条件 |
| ∟ ∟ ∟ ∟ children | array[object] | 子筛选条件 |
| ∟ ∟ ∟ ∟ condition_list | array[object] | 查询条件数组 |
| ∟ ∟ ∟ ∟ opt | string[enum] | 操作符 eq；ne；gt；ge；lt；le；contains；notContains；startsWith；endsWith；isNull；isNotNull；between；notBetween |
| ∟ ∟ ∟ filter | object | 过滤条件 |
| ∟ ∟ ∟ ∟ children | array[object] | 子筛选条件 |
| ∟ ∟ ∟ ∟ condition_list | array[object] | 查询条件数组 |
| ∟ ∟ ∟ ∟ opt | string[enum] | 操作符 eq；ne；gt；ge；lt；le；contains；notContains；startsWith；endsWith；isNull；isNotNull；between；notBetween |
| ∟ ∟ ∟ format | string | 格式 |
| ∟ ∟ ∟ format | string | 格式 |
| ∟ ∟ ∟ format | string | 格式，包括文本、邮箱、URL、手机号码、身份证号码 |
| ∟ ∟ ∟ format | string | 格式 |
| ∟ ∟ ∟ format | string | 展示格式 |
| ∟ ∟ ∟ format_setting_barcode_display_value | boolean | 函数设置二维码展示值 |
| ∟ ∟ ∟ format_setting_barcode_height | string | 函数设置二维码高度 |
| ∟ ∟ ∟ format_setting_image_fit | string | 函数设置图像填充 |
| ∟ ∟ ∟ format_setting_image_height | string | 函数设置图像宽度 |
| ∟ ∟ ∟ format_setting_image_width | string | 函数设置图像宽度 |
| ∟ ∟ ∟ format_setting_spark_line_fill | boolean | 函数设置边框选线填充 |
| ∟ ∟ ∟ formula | string | 函数公式 |
| ∟ ∟ ∟ func | string | 汇总函数 |
| ∟ ∟ ∟ gt_field_id | string | 大于的字段 id |
| ∟ ∟ ∟ heart | string | 评分样式 |
| ∟ ∟ ∟ hide_create_button | boolean | 隐藏创建按钮 |
| ∟ ∟ ∟ hide_edit_button | boolean | 隐藏编辑按钮 |
| ∟ ∟ ∟ icon | string | 展示图标 |
| ∟ ∟ ∟ icon | string | 图标 |
| ∟ ∟ ∟ level | string | 层级 |
| ∟ ∟ ∟ lt_field_id | string | 小于的字段 id |
| ∟ ∟ ∟ max | integer | 最大文本字符长度 |
| ∟ ∟ ∟ max | integer | 最大文本字符长度 |
| ∟ ∟ ∟ max | integer | 最大值 |
| ∟ ∟ ∟ max | number | 最大值 |
| ∟ ∟ ∟ max_count | integer | 最大附件个数 |
| ∟ ∟ ∟ max_size | integer | 附件大小 |
| ∟ ∟ ∟ min | integer | 最小文本字符长度 |
| ∟ ∟ ∟ min | number | 最小值 |
| ∟ ∟ ∟ min | integer | 最小值 |
| ∟ ∟ ∟ min | integer | 最小文本字符长度 |
| ∟ ∟ ∟ multiple | boolean | 允许多选 |
| ∟ ∟ ∟ multiple | boolean | 允许多选 |
| ∟ ∟ ∟ multiple | boolean | 是否允许多选 |
| ∟ ∟ ∟ name | string | 签名名称 |
| ∟ ∟ ∟ not_null_check_delete | boolean | 非空下删除检查 |
| ∟ ∟ ∟ notification | boolean | 启用通知 |
| ∟ ∟ ∟ nullable | boolean | 是否允许为空 |
| ∟ ∟ ∟ nullable | boolean | 是否允许为空 |
| ∟ ∟ ∟ nullable | boolean | 是否允许为空 |
| ∟ ∟ ∟ nullable | boolean | 是否允许为空 |
| ∟ ∟ ∟ nullable | boolean | 是否允许为空 |
| ∟ ∟ ∟ nullable | boolean | 是否允许为空 |
| ∟ ∟ ∟ nullable | boolean | 是否允许为空 |
| ∟ ∟ ∟ nullable | boolean | 是否允许为空 |
| ∟ ∟ ∟ nullable | boolean | 是否允许为空 |
| ∟ ∟ ∟ nullable | boolean | 是否允许为空 |
| ∟ ∟ ∟ nullable | boolean | 是否允许为空 |
| ∟ ∟ ∟ nullable | boolean | 是否允许为空 |
| ∟ ∟ ∟ nullable | boolean | 是否允许为空 |
| ∟ ∟ ∟ nullable | boolean | 是否允许为空 |
| ∟ ∟ ∟ nullable | boolean | 是否允许为空 |
| ∟ ∟ ∟ nullable | boolean | 是否允许为空 |
| ∟ ∟ ∟ nullable | boolean | 是否允许为空 |
| ∟ ∟ ∟ option_list | array[object] | 选项列表 |
| ∟ ∟ ∟ ∟ checked | boolean | 是否勾选 |
| ∟ ∟ ∟ ∟ color | string | 选项颜色 |
| ∟ ∟ ∟ ∟ id | string | 选项 id |
| ∟ ∟ ∟ ∟ name | string | 选项名称 |
| ∟ ∟ ∟ precision | integer | 精度 |
| ∟ ∟ ∟ precision | integer | 精度 |
| ∟ ∟ ∟ prefix | string | 编号前缀 |
| ∟ ∟ ∟ query_and_no_show | boolean | 查询并且不展示 |
| ∟ ∟ ∟ relation_field_id | string | 关联字段 id |
| ∟ ∟ ∟ reset_type | string | 重置类型，day: 每天重置，month: 每月重置，year: 每年重置 |
| ∟ ∟ ∟ rollup_field_id | string | 汇总字段 id |
| ∟ ∟ ∟ rollup_table_id | string | 汇总数据表 id |
| ∟ ∟ ∟ search_filter_field_default_value_list | array[string] | 搜索字段默认值列表 |
| ∟ ∟ ∟ search_filter_field_list | array[string] | 搜索过滤字段列表 |
| ∟ ∟ ∟ search_order_by_list | array[object] | 搜索排序字段列表 |
| ∟ ∟ ∟ ∟ field | string | 排序字段 id |
| ∟ ∟ ∟ ∟ is_name | boolean | 显示名称 |
| ∟ ∟ ∟ ∟ type | string | 升序排、降序排 |
| ∟ ∟ ∟ search_order_by_list | array[string] | 搜索排序字段列表 |
| ∟ ∟ ∟ search_order_by_list | array[object] | 搜索排序字段列表 |
| ∟ ∟ ∟ ∟ field | string | 排序字段 id |
| ∟ ∟ ∟ ∟ is_name | boolean | 显示名称 |
| ∟ ∟ ∟ ∟ type | string | 升序排、降序排 |
| ∟ ∟ ∟ search_show_field_list | array[string] | 搜索面板展示字段列表 |
| ∟ ∟ ∟ search_show_field_list | array[string] | 搜索面板展示字段列表 |
| ∟ ∟ ∟ search_show_field_list | array[string] | 搜索面板展示字段列表 |
| ∟ ∟ ∟ search_type | string | 搜索类型 |
| ∟ ∟ ∟ searchable | boolean | 允许搜索 |
| ∟ ∟ ∟ show_form_view | boolean | 展示表单视图 |
| ∟ ∟ ∟ show_time | boolean | 显示时间 |
| ∟ ∟ ∟ show_type_list | string | 展示类型列表 |
| ∟ ∟ ∟ sortable | boolean | 允许排序 |
| ∟ ∟ ∟ source_field_id | string | 源字段 id |
| ∟ ∟ ∟ source_table_id | string | 源表 id |
| ∟ ∟ ∟ split | string | 分隔符 |
| ∟ ∟ ∟ split_comma | string | 分隔符 |
| ∟ ∟ ∟ table_id | string | 数据表 id |
| ∟ ∟ ∟ table_id | string | 查找表 id |
| ∟ ∟ ∟ table_id | string | 关联表 id |
| ∟ ∟ ∟ target_field_id | string | 目标字段 id |
| ∟ ∟ ∟ target_table_id | string | 目标数据表 id |
| ∟ ∟ ∟ unique | boolean | 是否允许重复数据 |
| ∟ ∟ ∟ unique | boolean | 是否允许重复数据 |
| ∟ ∟ ∟ use_field_concat | boolean | 是否使用字段拼接名称 |
| ∟ ∟ ∟ use_now_as_default_value | boolean | 使用创建时间作为默认时间 |
| ∟ ∟ ∟ value_field_list | array[string] | 值字段拼接列表 |
| ∟ ∟ ∟ value_field_separator | string | 值字段拼接分隔符 |
| ∟ ∟ ∟ value_tree | array[object] | 级联选择值对象树 |
| ∟ ∟ ∟ ∟ children | array[object] | 级联子对象 |
| ∟ ∟ ∟ ∟ id | string | 级联对象 id |
| ∟ ∟ ∟ ∟ name | string | 级联对象名称 |
| ∟ ∟ ∟ width | integer | 填充宽度 |
| ∟ ∟ ∟ width | integer | 签名像素宽度 |
| ∟ ∟ type | string[enum] | 字段类型 Name；SingleText；MultiText；RichText；Attachment；Checkbox；SingleSelect；MultiSelect；Member；Account；Date；Time；Integer；Double；Rate；Color；Category；Cascader；Region；Coordinate；Children；Relation；RelationRollup；RelationRecord；RelationRecordField；RelationRecordLookupList；ID；Formula；CreateTime；LastModifyTime；CreateUser；LastModifyUser；StaticText；IndexNumber；Signature；Department |
| ∟ table | object | 低代码数据表定义 |
| ∟ ∟ id | string | 数据表 id |
| ∟ ∟ name | string | 数据表名称 |
| more | object | 更多的错误信息 |
响应体示例
json
{
"code": 0,
"data": {
"items": [
{
"id": "string",
"name": "string",
"nullable": false,
"setting": {
"accept_types": "string",
"allow_multi_parent": false,
"allow_negative": false,
"card_field_list": [
"string"
],
"card_order_by_list": [
{
"field": "string",
"is_name": false,
"type": "string"
}
],
"category_tree": [
{
"children": [],
"color": "string",
"id": "string",
"name": "string"
}
],
"children_fieldId": "string",
"color": "string",
"count": 0,
"default_value": "string",
"depends_list": [
{
"field_id": "string",
"id": "string",
"rule": "string"
}
],
"disable_show_detail": false,
"display_width": 0,
"editable": false,
"editor_type": "string",
"enable_binding_source": false,
"enable_range": false,
"exportable": false,
"field_id": "string",
"filter": {
"children": [],
"condition_list": [],
"opt": "string[enum]"
},
"format": "string",
"format_setting_barcode_display_value": false,
"format_setting_barcode_height": "string",
"format_setting_image_fit": "string",
"format_setting_image_height": "string",
"format_setting_image_width": "string",
"format_setting_spark_line_fill": false,
"formula": "string",
"func": "string",
"gt_field_id": "string",
"heart": "string",
"hide_create_button": false,
"hide_edit_button": false,
"icon": "string",
"level": "string",
"lt_field_id": "string",
"max": 0,
"max_count": 0,
"max_size": 0,
"min": 0,
"multiple": false,
"name": "string",
"not_null_check_delete": false,
"notification": false,
"nullable": false,
"option_list": [
{
"checked": false,
"color": "string",
"id": "string",
"name": "string"
}
],
"precision": 0,
"prefix": "string",
"query_and_no_show": false,
"relation_field_id": "string",
"reset_type": "string",
"rollup_field_id": "string",
"rollup_table_id": "string",
"search_filter_field_default_value_list": [
"string"
],
"search_filter_field_list": [
"string"
],
"search_order_by_list": [
{
"field": "string",
"is_name": false,
"type": "string"
}
],
"search_show_field_list": [
"string"
],
"search_type": "string",
"searchable": false,
"show_form_view": false,
"show_time": false,
"show_type_list": "string",
"sortable": false,
"source_field_id": "string",
"source_table_id": "string",
"split": "string",
"split_comma": "string",
"table_id": "string",
"target_field_id": "string",
"target_table_id": "string",
"unique": false,
"use_field_concat": false,
"use_now_as_default_value": false,
"value_field_list": [
"string"
],
"value_field_separator": "string",
"value_tree": [
{
"children": [],
"id": "string",
"name": "string"
}
],
"width": 0
},
"type": "string[enum]"
}
],
"table": {
"id": "string",
"name": "string"
}
},
"msg": "string"
}