明道云开放平台

正在加载页面

鉴权方式

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

版本

请求地址

POST

Header 参数

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

Body 参数

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

响应参数

200成功创建工作表

名称	类型	描述
`success`	`boolean`	是否调用成功
`error_code`	`integer`	错误代码
`error_msg`	`string`	错误消息
`data`	`object`	工作表创建结果
`data.worksheetId`	`string`	工作表ID

curl -X POST "https://example.com/v3/app/worksheets" \  -H "HAP-Appkey: {{HAP-Appkey}}" \  -H "HAP-Sign: {{HAP-Sign}}" \  -H "Content-Type: application/json" \  -d '{    "name": "测试新建工作表",    "sectionId": "",    "fields": [      {        "name": "文本",        "alias": "",        "type": "2",        "required": true,        "isTitle": true      },      {        "name": "数值",        "alias": "",        "type": "6",        "precision": 2,        "required": true      },      {        "name": "单选",        "alias": "",        "type": "11",        "options": [          {            "value": "选项名称1",            "index": 1          },          {            "value": "选项名称2",            "index": 2          }        ],        "required": true      }    ]  }'

{  "data": {    "worksheetId": "worksheet123"  },  "success": true}

名称

类型

必填

描述

HAP-Appkey

string

是

HAP应用密钥

HAP-Sign

string

是

HAP签名

Body 参数

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

名称

类型

描述

success

boolean

是否调用成功

error_code

integer

错误代码

error_msg

string

错误消息

data

object

工作表创建结果

data.worksheetId

string

工作表ID

curl -X POST "https://example.com/v3/app/worksheets" \ -H "HAP-Appkey: {{HAP-Appkey}}" \ -H "HAP-Sign: {{HAP-Sign}}" \ -H "Content-Type: application/json" \ -d '{ "name": "测试新建工作表", "sectionId": "", "fields": [ { "name": "文本", "alias": "", "type": "2", "required": true, "isTitle": true }, { "name": "数值", "alias": "", "type": "6", "precision": 2, "required": true }, { "name": "单选", "alias": "", "type": "11", "options": [ { "value": "选项名称1", "index": 1 }, { "value": "选项名称2", "index": 2 } ], "required": true } ] }'