云存储接口/实体

字段

字段对象，依附于表格对象，以集合的形式出现，不同的字段的配置格式不同。分成两部分介绍，第一部分介绍字段的通用配置；第二部分根据字段不同的类型描述不同的个性化配置。

字段名称 字段类型 字段说明
field_id integer 字段唯一ID
type string 字段类型(统一信息), 文本：text, 数字：number, 分类：category, 用户：user, 日期：date, 图片：image, 计算：calculation, 关联：relation, 文件：file
name string 字段名称
description string 字段描述
config object 字段配置，根据不同类型，有不同的配置，详细配置说明见下文
default_setting object 字段默认值, 用于创建数据时给用户建议, 格式同数据提交时的值格式
range object 字段取值范围，筛选器对象
required bool 字段必须标识
unique bool 字段唯一标识
allow_update bool 字段是否允许修改标识
is_attach_field bool 是否为附加关联字段
attach_relation_field object 如果当前字段是联表字段，该值为产生的当前字段的单关联字段，字段对象
app_id integer 所属的应用ID
application_alias string 应用设置的字段别名
lock object 字段的锁定信息，该字段下的每个子字段的名称表示锁定的权限，每个子字段值表示锁定该权限的应用ID 
[
  {
    "field_id": 13001,
    "type": "text",
    "name": "会议标题",
    "description": "会议标题",
    "config": {
      "type": "input"
    },
    "default_setting": {
      "value": "这个家伙太懒,没写会议标题"
    },
    "range": {
      "keywords": [
        "xxx"
      ]
    },
    "required": true,
    "unique": true,
    "allow_update": true,
    "is_attach_field": false,
    "attach_relation_field": [],
    "app_id": null,
    "application_alias": null,
    "lock": {
      "update": 0,
      "delete": 0,
      "item_update": 0
    }
  }
]
文本字段（text）
字段名称 字段类型 字段说明
type string 文本子类型，单行文本：input，多行文本：textarea，富文本：rich 
{
  "field_id": 13001,
  "type": "text",
  "name": "会议标题",
  "description": "会议标题",
  "config": {
    "type": "input"
  }
}
用户字段（user）
字段名称 字段类型 字段说明
type string 字段子类型，单选：single，多选：multi 
{
  "field_id": 13002,
  "type": "user",
  "name": "会议参与人",
  "description": "会议参与人",
  "config": {
    "type": "single"
  }
}
分类字段（category）
字段名称 字段类型 字段说明
type string 字段子类型，单选：single，多选：multi
display_mode string 显示类型，下拉菜单：select，列表：list
colorful bool 是否展示彩色区块
display_mode string 显示类型，下拉菜单：select，列表：list
options array 选择对象，id选择ID，name选择名称，status选择状态，active表示正常，inactive表示删除，color展示颜色，与colorful共同作用分类展示样式 
{
  "field_id": 13003,
  "type": "category",
  "name": "会议类型",
  "description": "会议类型",
  "config": {
    "type": "multi",
    "display_mode": "select",
    "colorful": true,
    "options": [
      {
        "id": "1",
        "name": "A",
        "status": "active",
        "color": "red"
      },
      {
        "id": "2",
        "name": "B",
        "status": "active",
        "color": "green"
      }
    ]
  }
}
数字字段（number）
字段名称 字段类型 字段说明
unit_name string 数字单位
unit_position string 单位展示位置，surfix后缀展示，prefix前缀展示
precision integer 保留精度
display_mode string 展示类型，number展示为数字，percent展示为百分比 
{
  "field_id": 13006,
  "type": "number",
  "name": "会议申请电话数",
  "description": "会议申请电话数",
  "config": {
    "unit_name": "台",
    "unit_position": "surfix",
    "precision": 3,
    "display_mode": "number"
  }
}
日期字段（date）
字段名称 字段类型 字段说明
type string 日期子类型，date精确到日期，datetime精确到分钟 
{
  "field_id": 13005,
  "type": "date",
  "name": "会议时间",
  "description": "会议时间",
  "config": {
    "type": "datetime"
  }
}
图片字段（image）
字段名称 字段类型 字段说明 
{
  "field_id": 13006,
  "type": "number",
  "name": "会议申请电话数",
  "description": "会议申请电话数",
  "config": []
}
文件字段（file）
字段名称 字段类型 字段说明 
{
  "field_id": 13011,
  "type": "file",
  "name": "附件",
  "description": "附件",
  "config": []
}
关联字段（relation）
字段名称 字段类型 字段说明
table_id integer 关联表格ID
type string 字段子类型，单选：single，多选：multi
filter array 关联的表格条件，只有满足条件的数据才能关联到当前字段，格式参考全局筛选器 
{
  "field_id": 13008,
  "type": "relation",
  "name": "决议",
  "description": "决议",
  "config": {
    "table_id": 12002,
    "type": "single",
    "filter": []
  }
}
计算字段（calculation）
字段名称 字段类型 字段说明
formula string 计算公式，其中变量使用cal_N来表示，N是从0开始的整数
variables array 计算公式中的变量信息，type变量所使用的聚合函数，relation_field_id变量依赖的关联字段ID，relation_table_id变量依赖的表格ID，calculation_field_id计算的字段ID，COUNT聚合类型不需要该参数，calculation_table_id计算的表格ID，filter计算的表格条件，只有满足条件的数据才会被计算，格式参考全局筛选器
unit_name string 数字单位
unit_position string 单位展示位置，surfix后缀展示，prefix前缀展示
precision integer 保留精度
display_mode string 展示类型，number展示为数字，percent展示为百分比 
{
  "field_id": 13006,
  "type": "number",
  "name": "会议申请电话数",
  "description": "会议申请电话数",
  "config": {
    "unit_name": "台",
    "unit_position": "surfix",
    "precision": 3,
    "display_mode": "number"
  }
}