更新工作表结构

更新工作表结构，包括新增、编辑、删除字段

鉴权方式

AppKey + Sign 是应用密钥鉴权，由管理员创建，用于以应用管理员身份访问应用数据。

版本

请求地址

POST

Path 参数

名称	类型	必填	描述
`worksheet_id`	`string`	是	工作表ID 示例值：`"worksheet_id"`

Header 参数

名称	类型	必填	描述
`HAP-Appkey`	`string`	是	HAP应用密钥
`HAP-Sign`	`string`	是	HAP签名

Body 参数

名称	类型	必填	描述
`displayType`	`integer`	否	应用项导航显示模式：1=PC 与移动端均显示，2=全部隐藏，3=仅移动端显示，4=仅 PC 显示；创建默认 1，编辑不传则保持原状可选值： `1234`
`name`	`string`	否	工作表名称
`alias`	`string`	否	工作表别名
`remark`	`string`	否	工作表描述
`sectionId`	`string`	否	分组ID
`addFields`	`object[]`	否	新增的字段
`addFields.sourceField`	`string`	否	关联字段 ID ，适用于与dataSource表中已存在的单向关联字段创建双向关联。当 type=Relation 且dataSource不为空时传入，创建新关联时不需要传入 Lookup、Rollup 时为目标表的来源字段 ID 或别名；Rollup 的 count 计数可省略
`addFields.relationField`	`string`	否	Lookup 或 Rollup 引用的本表关联字段 ID 或别名；Lookup 仅支持单条关联，Rollup 也支持子表。Lookup 创建后不可修改来源
`addFields.viewId`	`string`	否	CascadingSelect 使用的层级视图 ID
`addFields.config`	`object`	否	语义化字段配置；DSL 返回与创建、编辑使用相同的属性位置
`addFields.config.textMode`	`string`	否	文本显示模式，对应旧 subType 可选值： `"singleLine""multiLine""markdown"`
`addFields.config.isMultiple`	`boolean`	否	是否允许多选或多条，适用于下拉、成员、关联等字段
`addFields.config.code`	`string`	否	货币代码，如 CNY、USD，对应旧 unit
`addFields.config.format`	`string`	否	日期或时间的语义格式，对应旧 subType 或 unit；具体格式取决于字段类型
`addFields.config.expression`	`string`	否	文本组合或条码等字段的表达式，使用 $字段ID或别名$ 引用字段；兼容旧 dataSource，优先使用本属性
`addFields.config.displayMode`	`string`	否	条码：code128 或 qrCode；级联选择：cascader 或 tree；关联记录可使用 dropdown、card、inlineTable、tabTable
`addFields.config.storeData`	`boolean`	否	Lookup 是否存储数据副本；创建时不传默认 false，仅显示来源值；读取历史字段时返回其实际存储配置
`addFields.config.calcType`	`string`	否	Rollup 聚合类型，本次补充 sum、count、avg、max、min；count 时可省略 sourceField
`addFields.config.isColorOptions`	`boolean`	否	是否启用彩色选项
`addFields.config.bidirectional`	`boolean`	否	是否双向关联，DSL 与创建、编辑均在 config 中返回或设置
`addFields.config.showFields`	`string[]`	否	关联记录展示字段 ID 或别名列表
`addFields.layout`	`object`	否	字段排版布局
`addFields.layout.rowIndex`	`integer`	否	字段所在行，从 0 开始
`addFields.layout.span`	`integer`	否	字段所占宽度可选值： `346812`
`addFields.defaultValue`	`object[]`	否	字段默认值配置，DSL 返回完整来源信息，无配置时为空数组
`addFields.defaultValue.source`	`string`	否	值来源：静态值、系统值、当前表字段或关联字段可选值： `"static""system""field""relation"`
`addFields.defaultValue.value`	`string`	否	source 为 static 或 system 时的值
`addFields.defaultValue.field`	`string`	否	source 为 field 或 relation 时的字段 ID 或别名
`addFields.defaultValue.relationField`	`string`	否	source 为 relation 时的关联字段 ID 或别名
`addFields.customWidget`	`object`	否	字段自定义前端展示配置；存储值沿用 Text、Number、Date、DateTime、Time、SingleSelect、MultipleSelect、Relation 等原字段类型，纯展示使用 CustomField
`addFields.customWidget.height`	`integer`	否	组件展示高度，单位像素
`addFields.customWidget.script`	`string`	否	React 函数组件脚本
`addFields.customWidget.reference`	`object[]`	否	纯展示组件引用的字段变量
`addFields.customWidget.reference.name`	`string`	否	脚本中的变量名
`addFields.customWidget.reference.field`	`string`	否	引用字段 ID 或别名
`addFields.name`	`string`	是	字段名称
`addFields.type`	`string`	是	字段类型；新增支持 Signature（签名，无需额外配置）、Concatenate（文本组合）、Barcode（条码）、Lookup（他表字段）、Rollup（汇总）、CascadingSelect（级联选择）和 CustomField（纯展示自定义字段）。字段创建后不可变更类型
`addFields.alias`	`string`	否	字段别名
`addFields.remark`	`string`	否	字段描述
`addFields.desc`	`string`	否	字段说明
`addFields.required`	`boolean`	否	是否必填示例值：`false`
`addFields.isTitle`	`boolean`	否	是否为标题字段示例值：`false`
`addFields.isHidden`	`boolean`	否	是否隐藏示例值：`false`
`addFields.isReadOnly`	`boolean`	否	是否只读示例值：`false`
`addFields.isHiddenOnCreate`	`boolean`	否	是否新增记录时隐藏示例值：`false`
`addFields.isUnique`	`boolean`	否	是否唯一示例值：`false`
`addFields.precision`	`integer`	否	保留小数位（0-14），字段类型为Number时传入 Rollup 时用于指定汇总结果的小数位数
`addFields.subType`	`string`	否	子类型配置： type=Collaborator时：成员数量，0：单选，1：多选 type=Relation时：关联记录数量，1：单条，2：多条 type=Time时：时间格式，1：时.分，6：时.分.秒 type=Date\|DateTime时：日期格式，5：年，4：年月，3：年月日，2：年月日时，1：年月日时分，6：年月日时分秒
`addFields.options`	`object[]`	否	选项信息，type=SingleSelect/MultipleSelect时填入
`addFields.options.color`	`string`	否	选项颜色，使用 HEX 色值，例如 #F52222
`addFields.options.value`	`string`	是	选项名称
`addFields.options.index`	`integer`	是	选项排序
`addFields.relation`	`object`	否	type=Relation时传入，关联字段字段配置项
`addFields.relation.showFields`	`string[]`	否	关联表展示字段
`addFields.relation.bidirectional`	`boolean`	否	是否为双向关联 true：双向，false：单向
`addFields.max`	`integer`	否	等级最大值（0-10），type=Rating时传入
`addFields.dataSource`	`string`	否	关联表ID，type=Relation时传入 CascadingSelect 时为目标工作表 ID 或别名；Concatenate、Barcode 兼容旧表达式，优先使用 config.expression
`editFields`	`any[]`	否	编辑的字段
`editFields.id`	`string`	是	字段ID/别名
`editFields.sourceField`	`string`	否	关联字段 ID ，适用于与dataSource表中已存在的单向关联字段创建双向关联。当 type=Relation 且dataSource不为空时传入，创建新关联时不需要传入 Lookup、Rollup 时为目标表的来源字段 ID 或别名；Rollup 的 count 计数可省略
`editFields.relationField`	`string`	否	Lookup 或 Rollup 引用的本表关联字段 ID 或别名；Lookup 仅支持单条关联，Rollup 也支持子表。Lookup 创建后不可修改来源
`editFields.viewId`	`string`	否	CascadingSelect 使用的层级视图 ID
`editFields.config`	`object`	否	语义化字段配置；DSL 返回与创建、编辑使用相同的属性位置
`editFields.config.textMode`	`string`	否	文本显示模式，对应旧 subType 可选值： `"singleLine""multiLine""markdown"`
`editFields.config.isMultiple`	`boolean`	否	是否允许多选或多条，适用于下拉、成员、关联等字段
`editFields.config.code`	`string`	否	货币代码，如 CNY、USD，对应旧 unit
`editFields.config.format`	`string`	否	日期或时间的语义格式，对应旧 subType 或 unit；具体格式取决于字段类型
`editFields.config.expression`	`string`	否	文本组合或条码等字段的表达式，使用 $字段ID或别名$ 引用字段；兼容旧 dataSource，优先使用本属性
`editFields.config.displayMode`	`string`	否	条码：code128 或 qrCode；级联选择：cascader 或 tree；关联记录可使用 dropdown、card、inlineTable、tabTable
`editFields.config.storeData`	`boolean`	否	Lookup 是否存储数据副本；创建时不传默认 false，仅显示来源值；读取历史字段时返回其实际存储配置
`editFields.config.calcType`	`string`	否	Rollup 聚合类型，本次补充 sum、count、avg、max、min；count 时可省略 sourceField
`editFields.config.isColorOptions`	`boolean`	否	是否启用彩色选项
`editFields.config.bidirectional`	`boolean`	否	是否双向关联，DSL 与创建、编辑均在 config 中返回或设置
`editFields.config.showFields`	`string[]`	否	关联记录展示字段 ID 或别名列表
`editFields.layout`	`object`	否	字段排版布局
`editFields.layout.rowIndex`	`integer`	否	字段所在行，从 0 开始
`editFields.layout.span`	`integer`	否	字段所占宽度可选值： `346812`
`editFields.defaultValue`	`object[]`	否	字段默认值配置，DSL 返回完整来源信息，无配置时为空数组
`editFields.defaultValue.source`	`string`	否	值来源：静态值、系统值、当前表字段或关联字段可选值： `"static""system""field""relation"`
`editFields.defaultValue.value`	`string`	否	source 为 static 或 system 时的值
`editFields.defaultValue.field`	`string`	否	source 为 field 或 relation 时的字段 ID 或别名
`editFields.defaultValue.relationField`	`string`	否	source 为 relation 时的关联字段 ID 或别名
`editFields.customWidget`	`object`	否	字段自定义前端展示配置；存储值沿用 Text、Number、Date、DateTime、Time、SingleSelect、MultipleSelect、Relation 等原字段类型，纯展示使用 CustomField
`editFields.customWidget.height`	`integer`	否	组件展示高度，单位像素
`editFields.customWidget.script`	`string`	否	React 函数组件脚本
`editFields.customWidget.reference`	`object[]`	否	纯展示组件引用的字段变量
`editFields.customWidget.reference.name`	`string`	否	脚本中的变量名
`editFields.customWidget.reference.field`	`string`	否	引用字段 ID 或别名
`editFields.name`	`string`	否	字段名称
`editFields.type`	`string`	否	字段类型；新增支持 Signature（签名，无需额外配置）、Concatenate（文本组合）、Barcode（条码）、Lookup（他表字段）、Rollup（汇总）、CascadingSelect（级联选择）和 CustomField（纯展示自定义字段）。字段创建后不可变更类型
`editFields.alias`	`string`	否	字段别名
`editFields.remark`	`string`	否	字段描述
`editFields.desc`	`string`	否	字段说明
`editFields.required`	`boolean`	否	是否必填示例值：`false`
`editFields.isTitle`	`boolean`	否	是否为标题字段示例值：`false`
`editFields.isHidden`	`boolean`	否	是否隐藏示例值：`false`
`editFields.isReadOnly`	`boolean`	否	是否只读示例值：`false`
`editFields.isHiddenOnCreate`	`boolean`	否	是否新增记录时隐藏示例值：`false`
`editFields.isUnique`	`boolean`	否	是否唯一示例值：`false`
`editFields.precision`	`integer`	否	保留小数位（0-14），type=Number时传入 Rollup 时用于指定汇总结果的小数位数
`editFields.subType`	`string`	否	type=Collaborator时：成员数量，0：单选，1：多选 type=Relation时：关联记录数量，1：单条，2：多条 type=Time时：时间格式，1：时.分，6：时.分.秒 type=Date\|DateTime时：日期格式，5：年，4：年月，3：年月日，2：年月日时，1：年月日时分，6：年月日时分秒
`editFields.options`	`object[]`	否	选项信息，type=SingleSelect/MultipleSelect时填入
`editFields.options.color`	`string`	否	选项颜色，使用 HEX 色值，例如 #F52222
`editFields.options.value`	`string`	是	选项名称
`editFields.options.index`	`integer`	是	选项排序
`editFields.relation`	`object`	否	type=Relation时传入，关联字段字段配置项
`editFields.relation.showFields`	`string[]`	否	关联表展示字段
`editFields.max`	`integer`	否	等级最大值（0-10），type=Rating时传入
`editFields.dataSource`	`string`	否	关联表ID，type=Relation时传入 CascadingSelect 时为目标工作表 ID 或别名；Concatenate、Barcode 兼容旧表达式，优先使用 config.expression
`removeFields`	`string[]`	否	删除的字段ID列表

响应参数

200成功更新工作表结构

名称	类型	描述
`success`	`boolean`	是否调用成功
`error_code`	`integer`	错误代码
`error_msg`	`string`	错误消息
`data`	`object`	空数据对象

curl -X POST "https://example.com/v3/app/worksheets/worksheet_id" \  -H "HAP-Appkey: {{HAP-Appkey}}" \  -H "HAP-Sign: {{HAP-Sign}}" \  -H "Content-Type: application/json" \  -d '{    "displayType": 3,    "addFields": [      {        "name": "string",        "alias": "biz_customer_signature",        "type": "Signature",        "required": false,        "layout": {          "rowIndex": 0,          "span": 12        }      },      {        "name": "string",        "alias": "biz_full_address",        "type": "Concatenate",        "config": {          "expression": "$biz_color_picker$"        },        "required": false,        "layout": {          "rowIndex": 1,          "span": 12        }      },      {        "name": "string",        "alias": "biz_product_qr_code",        "type": "Barcode",        "config": {          "displayMode": "qrCode",          "expression": "$biz_color_picker$"        },        "required": false,        "layout": {          "rowIndex": 2,          "span": 12        }      },      {        "name": "string",        "alias": "biz_customer_phone",        "type": "Lookup",        "relationField": "biz_rel_customer",        "sourceField": "string",        "isReadOnly": true,        "config": {          "storeData": true        },        "required": false,        "layout": {          "rowIndex": 3,          "span": 12        }      },      {        "name": "string",        "alias": "biz_total",        "type": "Rollup",        "relationField": "biz_rel_customer",        "sourceField": "string",        "precision": 2,        "isReadOnly": true,        "config": {          "calcType": "sum"        },        "required": false,        "layout": {          "rowIndex": 4,          "span": 12        }      },      {        "name": "string",        "alias": "biz_industry_cascader",        "type": "CascadingSelect",        "dataSource": "string",        "viewId": "string",        "config": {          "displayMode": "cascader"        },        "required": false,        "layout": {          "rowIndex": 5,          "span": 12        }      },      {        "name": "string",        "alias": "biz_color_picker",        "type": "Text",        "config": {          "textMode": "singleLine"        },        "defaultValue": [          {            "source": "static",            "value": "#2196f3"          }        ],        "customWidget": {          "height": 240,          "script": "function ColorPicker() { return null; }"        },        "required": false,        "layout": {          "rowIndex": 6,          "span": 12        }      },      {        "name": "string",        "alias": "biz_flower_display",        "type": "CustomField",        "customWidget": {          "height": 240,          "script": "function FlowerDisplay() { return null; }",          "reference": [            {              "name": "color",              "field": "biz_color_picker"            }          ]        },        "required": false,        "layout": {          "rowIndex": 7,          "span": 12        }      },      {        "name": "string",        "alias": "biz_status",        "type": "SingleSelect",        "config": {          "isColorOptions": true        },        "options": [          {            "value": "string",            "index": 0,            "color": "#F52222"          }        ],        "required": false,        "layout": {          "rowIndex": 8,          "span": 12        }      },      {        "name": "string",        "alias": "biz_rel_customer",        "type": "Relation",        "dataSource": "string",        "config": {          "isMultiple": false,          "bidirectional": false,          "displayMode": "card",          "showFields": [            "string"          ]        },        "required": false,        "layout": {          "rowIndex": 9,          "span": 12        }      },      {        "name": "string",        "alias": "biz_amount",        "type": "Currency",        "config": {          "code": "CNY"        },        "required": false,        "layout": {          "rowIndex": 10,          "span": 12        }      },      {        "name": "string",        "alias": "biz_date",        "type": "Date",        "config": {          "format": "yyyy-MM-dd"        },        "required": false,        "layout": {          "rowIndex": 11,          "span": 12        }      },      {        "name": "string",        "alias": "biz_phone_copy",        "type": "Text",        "defaultValue": [          {            "source": "relation",            "relationField": "biz_rel_customer",            "field": "string"          }        ],        "required": false,        "layout": {          "rowIndex": 12,          "span": 12        }      }    ]  }'

{  "success": true,  "error_code": 0,  "error_msg": "string",  "data": {}}

获取工作表列表

获取应用下的所有工作表或者指定的工作表列表

删除工作表

工作表

更新工作表结构

更新工作表结构，包括新增、编辑、删除字段

鉴权方式

AppKey + Sign 是应用密钥鉴权，由管理员创建，用于以应用管理员身份访问应用数据。

版本

请求地址

POST

Path 参数

名称	类型	必填	描述
`worksheet_id`	`string`	是	工作表ID 示例值：`"worksheet_id"`

Header 参数

名称	类型	必填	描述
`HAP-Appkey`	`string`	是	HAP应用密钥
`HAP-Sign`	`string`	是	HAP签名

Body 参数

名称	类型	必填	描述
`displayType`	`integer`	否	应用项导航显示模式：1=PC 与移动端均显示，2=全部隐藏，3=仅移动端显示，4=仅 PC 显示；创建默认 1，编辑不传则保持原状可选值： `1234`
`name`	`string`	否	工作表名称
`alias`	`string`	否	工作表别名
`remark`	`string`	否	工作表描述
`sectionId`	`string`	否	分组ID
`addFields`	`object[]`	否	新增的字段
`addFields.sourceField`	`string`	否	关联字段 ID ，适用于与dataSource表中已存在的单向关联字段创建双向关联。当 type=Relation 且dataSource不为空时传入，创建新关联时不需要传入 Lookup、Rollup 时为目标表的来源字段 ID 或别名；Rollup 的 count 计数可省略
`addFields.relationField`	`string`	否	Lookup 或 Rollup 引用的本表关联字段 ID 或别名；Lookup 仅支持单条关联，Rollup 也支持子表。Lookup 创建后不可修改来源
`addFields.viewId`	`string`	否	CascadingSelect 使用的层级视图 ID
`addFields.config`	`object`	否	语义化字段配置；DSL 返回与创建、编辑使用相同的属性位置
`addFields.config.textMode`	`string`	否	文本显示模式，对应旧 subType 可选值： `"singleLine""multiLine""markdown"`
`addFields.config.isMultiple`	`boolean`	否	是否允许多选或多条，适用于下拉、成员、关联等字段
`addFields.config.code`	`string`	否	货币代码，如 CNY、USD，对应旧 unit
`addFields.config.format`	`string`	否	日期或时间的语义格式，对应旧 subType 或 unit；具体格式取决于字段类型
`addFields.config.expression`	`string`	否	文本组合或条码等字段的表达式，使用 $字段ID或别名$ 引用字段；兼容旧 dataSource，优先使用本属性
`addFields.config.displayMode`	`string`	否	条码：code128 或 qrCode；级联选择：cascader 或 tree；关联记录可使用 dropdown、card、inlineTable、tabTable
`addFields.config.storeData`	`boolean`	否	Lookup 是否存储数据副本；创建时不传默认 false，仅显示来源值；读取历史字段时返回其实际存储配置
`addFields.config.calcType`	`string`	否	Rollup 聚合类型，本次补充 sum、count、avg、max、min；count 时可省略 sourceField
`addFields.config.isColorOptions`	`boolean`	否	是否启用彩色选项
`addFields.config.bidirectional`	`boolean`	否	是否双向关联，DSL 与创建、编辑均在 config 中返回或设置
`addFields.config.showFields`	`string[]`	否	关联记录展示字段 ID 或别名列表
`addFields.layout`	`object`	否	字段排版布局
`addFields.layout.rowIndex`	`integer`	否	字段所在行，从 0 开始
`addFields.layout.span`	`integer`	否	字段所占宽度可选值： `346812`
`addFields.defaultValue`	`object[]`	否	字段默认值配置，DSL 返回完整来源信息，无配置时为空数组
`addFields.defaultValue.source`	`string`	否	值来源：静态值、系统值、当前表字段或关联字段可选值： `"static""system""field""relation"`
`addFields.defaultValue.value`	`string`	否	source 为 static 或 system 时的值
`addFields.defaultValue.field`	`string`	否	source 为 field 或 relation 时的字段 ID 或别名
`addFields.defaultValue.relationField`	`string`	否	source 为 relation 时的关联字段 ID 或别名
`addFields.customWidget`	`object`	否	字段自定义前端展示配置；存储值沿用 Text、Number、Date、DateTime、Time、SingleSelect、MultipleSelect、Relation 等原字段类型，纯展示使用 CustomField
`addFields.customWidget.height`	`integer`	否	组件展示高度，单位像素
`addFields.customWidget.script`	`string`	否	React 函数组件脚本
`addFields.customWidget.reference`	`object[]`	否	纯展示组件引用的字段变量
`addFields.customWidget.reference.name`	`string`	否	脚本中的变量名
`addFields.customWidget.reference.field`	`string`	否	引用字段 ID 或别名
`addFields.name`	`string`	是	字段名称
`addFields.type`	`string`	是	字段类型；新增支持 Signature（签名，无需额外配置）、Concatenate（文本组合）、Barcode（条码）、Lookup（他表字段）、Rollup（汇总）、CascadingSelect（级联选择）和 CustomField（纯展示自定义字段）。字段创建后不可变更类型
`addFields.alias`	`string`	否	字段别名
`addFields.remark`	`string`	否	字段描述
`addFields.desc`	`string`	否	字段说明
`addFields.required`	`boolean`	否	是否必填示例值：`false`
`addFields.isTitle`	`boolean`	否	是否为标题字段示例值：`false`
`addFields.isHidden`	`boolean`	否	是否隐藏示例值：`false`
`addFields.isReadOnly`	`boolean`	否	是否只读示例值：`false`
`addFields.isHiddenOnCreate`	`boolean`	否	是否新增记录时隐藏示例值：`false`
`addFields.isUnique`	`boolean`	否	是否唯一示例值：`false`
`addFields.precision`	`integer`	否	保留小数位（0-14），字段类型为Number时传入 Rollup 时用于指定汇总结果的小数位数
`addFields.subType`	`string`	否	子类型配置： type=Collaborator时：成员数量，0：单选，1：多选 type=Relation时：关联记录数量，1：单条，2：多条 type=Time时：时间格式，1：时.分，6：时.分.秒 type=Date\|DateTime时：日期格式，5：年，4：年月，3：年月日，2：年月日时，1：年月日时分，6：年月日时分秒
`addFields.options`	`object[]`	否	选项信息，type=SingleSelect/MultipleSelect时填入
`addFields.options.color`	`string`	否	选项颜色，使用 HEX 色值，例如 #F52222
`addFields.options.value`	`string`	是	选项名称
`addFields.options.index`	`integer`	是	选项排序
`addFields.relation`	`object`	否	type=Relation时传入，关联字段字段配置项
`addFields.relation.showFields`	`string[]`	否	关联表展示字段
`addFields.relation.bidirectional`	`boolean`	否	是否为双向关联 true：双向，false：单向
`addFields.max`	`integer`	否	等级最大值（0-10），type=Rating时传入
`addFields.dataSource`	`string`	否	关联表ID，type=Relation时传入 CascadingSelect 时为目标工作表 ID 或别名；Concatenate、Barcode 兼容旧表达式，优先使用 config.expression
`editFields`	`any[]`	否	编辑的字段
`editFields.id`	`string`	是	字段ID/别名
`editFields.sourceField`	`string`	否	关联字段 ID ，适用于与dataSource表中已存在的单向关联字段创建双向关联。当 type=Relation 且dataSource不为空时传入，创建新关联时不需要传入 Lookup、Rollup 时为目标表的来源字段 ID 或别名；Rollup 的 count 计数可省略
`editFields.relationField`	`string`	否	Lookup 或 Rollup 引用的本表关联字段 ID 或别名；Lookup 仅支持单条关联，Rollup 也支持子表。Lookup 创建后不可修改来源
`editFields.viewId`	`string`	否	CascadingSelect 使用的层级视图 ID
`editFields.config`	`object`	否	语义化字段配置；DSL 返回与创建、编辑使用相同的属性位置
`editFields.config.textMode`	`string`	否	文本显示模式，对应旧 subType 可选值： `"singleLine""multiLine""markdown"`
`editFields.config.isMultiple`	`boolean`	否	是否允许多选或多条，适用于下拉、成员、关联等字段
`editFields.config.code`	`string`	否	货币代码，如 CNY、USD，对应旧 unit
`editFields.config.format`	`string`	否	日期或时间的语义格式，对应旧 subType 或 unit；具体格式取决于字段类型
`editFields.config.expression`	`string`	否	文本组合或条码等字段的表达式，使用 $字段ID或别名$ 引用字段；兼容旧 dataSource，优先使用本属性
`editFields.config.displayMode`	`string`	否	条码：code128 或 qrCode；级联选择：cascader 或 tree；关联记录可使用 dropdown、card、inlineTable、tabTable
`editFields.config.storeData`	`boolean`	否	Lookup 是否存储数据副本；创建时不传默认 false，仅显示来源值；读取历史字段时返回其实际存储配置
`editFields.config.calcType`	`string`	否	Rollup 聚合类型，本次补充 sum、count、avg、max、min；count 时可省略 sourceField
`editFields.config.isColorOptions`	`boolean`	否	是否启用彩色选项
`editFields.config.bidirectional`	`boolean`	否	是否双向关联，DSL 与创建、编辑均在 config 中返回或设置
`editFields.config.showFields`	`string[]`	否	关联记录展示字段 ID 或别名列表
`editFields.layout`	`object`	否	字段排版布局
`editFields.layout.rowIndex`	`integer`	否	字段所在行，从 0 开始
`editFields.layout.span`	`integer`	否	字段所占宽度可选值： `346812`
`editFields.defaultValue`	`object[]`	否	字段默认值配置，DSL 返回完整来源信息，无配置时为空数组
`editFields.defaultValue.source`	`string`	否	值来源：静态值、系统值、当前表字段或关联字段可选值： `"static""system""field""relation"`
`editFields.defaultValue.value`	`string`	否	source 为 static 或 system 时的值
`editFields.defaultValue.field`	`string`	否	source 为 field 或 relation 时的字段 ID 或别名
`editFields.defaultValue.relationField`	`string`	否	source 为 relation 时的关联字段 ID 或别名
`editFields.customWidget`	`object`	否	字段自定义前端展示配置；存储值沿用 Text、Number、Date、DateTime、Time、SingleSelect、MultipleSelect、Relation 等原字段类型，纯展示使用 CustomField
`editFields.customWidget.height`	`integer`	否	组件展示高度，单位像素
`editFields.customWidget.script`	`string`	否	React 函数组件脚本
`editFields.customWidget.reference`	`object[]`	否	纯展示组件引用的字段变量
`editFields.customWidget.reference.name`	`string`	否	脚本中的变量名
`editFields.customWidget.reference.field`	`string`	否	引用字段 ID 或别名
`editFields.name`	`string`	否	字段名称
`editFields.type`	`string`	否	字段类型；新增支持 Signature（签名，无需额外配置）、Concatenate（文本组合）、Barcode（条码）、Lookup（他表字段）、Rollup（汇总）、CascadingSelect（级联选择）和 CustomField（纯展示自定义字段）。字段创建后不可变更类型
`editFields.alias`	`string`	否	字段别名
`editFields.remark`	`string`	否	字段描述
`editFields.desc`	`string`	否	字段说明
`editFields.required`	`boolean`	否	是否必填示例值：`false`
`editFields.isTitle`	`boolean`	否	是否为标题字段示例值：`false`
`editFields.isHidden`	`boolean`	否	是否隐藏示例值：`false`
`editFields.isReadOnly`	`boolean`	否	是否只读示例值：`false`
`editFields.isHiddenOnCreate`	`boolean`	否	是否新增记录时隐藏示例值：`false`
`editFields.isUnique`	`boolean`	否	是否唯一示例值：`false`
`editFields.precision`	`integer`	否	保留小数位（0-14），type=Number时传入 Rollup 时用于指定汇总结果的小数位数
`editFields.subType`	`string`	否	type=Collaborator时：成员数量，0：单选，1：多选 type=Relation时：关联记录数量，1：单条，2：多条 type=Time时：时间格式，1：时.分，6：时.分.秒 type=Date\|DateTime时：日期格式，5：年，4：年月，3：年月日，2：年月日时，1：年月日时分，6：年月日时分秒
`editFields.options`	`object[]`	否	选项信息，type=SingleSelect/MultipleSelect时填入
`editFields.options.color`	`string`	否	选项颜色，使用 HEX 色值，例如 #F52222
`editFields.options.value`	`string`	是	选项名称
`editFields.options.index`	`integer`	是	选项排序
`editFields.relation`	`object`	否	type=Relation时传入，关联字段字段配置项
`editFields.relation.showFields`	`string[]`	否	关联表展示字段
`editFields.max`	`integer`	否	等级最大值（0-10），type=Rating时传入
`editFields.dataSource`	`string`	否	关联表ID，type=Relation时传入 CascadingSelect 时为目标工作表 ID 或别名；Concatenate、Barcode 兼容旧表达式，优先使用 config.expression
`removeFields`	`string[]`	否	删除的字段ID列表

响应参数

200成功更新工作表结构

名称	类型	描述
`success`	`boolean`	是否调用成功
`error_code`	`integer`	错误代码
`error_msg`	`string`	错误消息
`data`	`object`	空数据对象

curl -X POST "https://example.com/v3/app/worksheets/worksheet_id" \  -H "HAP-Appkey: {{HAP-Appkey}}" \  -H "HAP-Sign: {{HAP-Sign}}" \  -H "Content-Type: application/json" \  -d '{    "displayType": 3,    "addFields": [      {        "name": "string",        "alias": "biz_customer_signature",        "type": "Signature",        "required": false,        "layout": {          "rowIndex": 0,          "span": 12        }      },      {        "name": "string",        "alias": "biz_full_address",        "type": "Concatenate",        "config": {          "expression": "$biz_color_picker$"        },        "required": false,        "layout": {          "rowIndex": 1,          "span": 12        }      },      {        "name": "string",        "alias": "biz_product_qr_code",        "type": "Barcode",        "config": {          "displayMode": "qrCode",          "expression": "$biz_color_picker$"        },        "required": false,        "layout": {          "rowIndex": 2,          "span": 12        }      },      {        "name": "string",        "alias": "biz_customer_phone",        "type": "Lookup",        "relationField": "biz_rel_customer",        "sourceField": "string",        "isReadOnly": true,        "config": {          "storeData": true        },        "required": false,        "layout": {          "rowIndex": 3,          "span": 12        }      },      {        "name": "string",        "alias": "biz_total",        "type": "Rollup",        "relationField": "biz_rel_customer",        "sourceField": "string",        "precision": 2,        "isReadOnly": true,        "config": {          "calcType": "sum"        },        "required": false,        "layout": {          "rowIndex": 4,          "span": 12        }      },      {        "name": "string",        "alias": "biz_industry_cascader",        "type": "CascadingSelect",        "dataSource": "string",        "viewId": "string",        "config": {          "displayMode": "cascader"        },        "required": false,        "layout": {          "rowIndex": 5,          "span": 12        }      },      {        "name": "string",        "alias": "biz_color_picker",        "type": "Text",        "config": {          "textMode": "singleLine"        },        "defaultValue": [          {            "source": "static",            "value": "#2196f3"          }        ],        "customWidget": {          "height": 240,          "script": "function ColorPicker() { return null; }"        },        "required": false,        "layout": {          "rowIndex": 6,          "span": 12        }      },      {        "name": "string",        "alias": "biz_flower_display",        "type": "CustomField",        "customWidget": {          "height": 240,          "script": "function FlowerDisplay() { return null; }",          "reference": [            {              "name": "color",              "field": "biz_color_picker"            }          ]        },        "required": false,        "layout": {          "rowIndex": 7,          "span": 12        }      },      {        "name": "string",        "alias": "biz_status",        "type": "SingleSelect",        "config": {          "isColorOptions": true        },        "options": [          {            "value": "string",            "index": 0,            "color": "#F52222"          }        ],        "required": false,        "layout": {          "rowIndex": 8,          "span": 12        }      },      {        "name": "string",        "alias": "biz_rel_customer",        "type": "Relation",        "dataSource": "string",        "config": {          "isMultiple": false,          "bidirectional": false,          "displayMode": "card",          "showFields": [            "string"          ]        },        "required": false,        "layout": {          "rowIndex": 9,          "span": 12        }      },      {        "name": "string",        "alias": "biz_amount",        "type": "Currency",        "config": {          "code": "CNY"        },        "required": false,        "layout": {          "rowIndex": 10,          "span": 12        }      },      {        "name": "string",        "alias": "biz_date",        "type": "Date",        "config": {          "format": "yyyy-MM-dd"        },        "required": false,        "layout": {          "rowIndex": 11,          "span": 12        }      },      {        "name": "string",        "alias": "biz_phone_copy",        "type": "Text",        "defaultValue": [          {            "source": "relation",            "relationField": "biz_rel_customer",            "field": "string"          }        ],        "required": false,        "layout": {          "rowIndex": 12,          "span": 12        }      }    ]  }'

{  "success": true,  "error_code": 0,  "error_msg": "string",  "data": {}}

获取工作表列表

获取应用下的所有工作表或者指定的工作表列表

删除工作表