企业内部开发 服务端API 文档 获取智能表格数据 查询字段
查询字段
最后更新:2024/06/21
可联系渠道经理采购或代理智慧硬件接口已支持设备 联系渠道经理
查询字段
最后更新:2024/06/21

目录

  • 查询字段
  • 参数详细说明
  •       Field
  •       FieldType
  •       NumberFieldProperty
  •       CheckboxFieldProperty
  •       DateTimeFieldProperty
  •       AttachmentFieldProperty
  •       UserFieldProperty
  •       UrlFieldProperty
  •       SelectFieldProperty
  •       CreatedTimeFieldProperty
  •       ModifiedTimeFieldProperty
  •       ProgressFieldProperty
  •       SingleSelectFieldProperty
  •       ReferenceFieldProperty
  •       LocationFieldProperty
  •       AutoNumberFieldProperty
  •       CurrencyFieldProperty
  •       WwGroupFieldProperty
  •       DecimalPlaces
  •       Format
  •       LinkType
  •       Option
  •       Style
  •       DisplayMode
  •       LocationInputType
  •       NumberType
  •       NumberRule
  •       CreateTimeFormat
  •       NumberRuleType
  •       CurrencyType
  • 查询字段

    本接口用于获取智能表中某个子表下字段信息,该接口可以完成下面三种功能:获取全部字段信息、依据字段名获取对应字段、依据字段 ID 获取对应字段信息。

    请求方式:POST(HTTPS)
    请求地址:https://qyapi.weixin.qq.com/cgi-bin/wedoc/smartsheet/get_fields?access_token=ACCESS_TOKEN

    请求包体

    {
    	"docid": "DOCID",
    	"sheet_id": "SHEETID",
    	"offset": 0,
    	"limit": 10
    }

    参数说明

    参数类型是否必须说明
    docidstring文档的docid
    sheet_idstring表格ID
    view_idstring视图 ID
    field_idsstring []由字段 ID 组成的 JSON 数组
    field_titlesstring []由字段标题组成的 JSON 数组
    offsetint偏移量,初始值为 0
    limitint分页大小 , 每页返回多少条数据;当不填写该参数或将该参数设置为 0 时,如果总数大于 1000,一次性返回 1000 个字段,当总数小于 1000 时,返回全部字段;limit 最大值为 1000

    权限说明

    返回示例

    {
    	"errcode": 0,
    	"errmsg": "ok",
    	"total": 1,
    	"fields": [{
    		"field_id": "ID1",
    		"field_title": "TITLE1",
    		"field_type": "FIELD_TYPE_TEXT"
    	}]
    }

    参数说明

    参数类型说明
    errcodeint32错误码
    errmsgstring错误码说明
    totalObject字段总数
    fieldsobject [](Field)字段详情

    参数详细说明

    Field

    字段信息:
    注意
    字段属性与字段类型是匹配的,一种字段类型对应一种字段属性

     

    参数名类型描述
    field_idstring字段 ID
    field_titlestring字段标题
    field_typestring字段类型,见FieldType
    property_numberobject(NumberFieldProperty)数字 类型的字段属性
    property_checkboxobject(CheckboxFieldProperty)复选框 类型的字段属性
    property_date_timeobject(DateTimeFieldProperty)日期 类型的字段属性
    property_attachmentobject(AttachmentFieldProperty)文件 类型的字段属性
    property_userobject(UserFieldProperty)人员 类型的字段属性
    property_urlobject(UrlFieldProperty)超链接 类型的字段属性
    property_selectobject(SelectFieldProperty)多选 类型的字段属性
    property_created_timeobject(CreatedTimeFieldProperty)创建时间 类型的字段属性
    property_modified_timeobject(ModifiedTimeFieldProperty)最后编辑时间 类型的字段属性
    property_progressobject(ProgressFieldProperty)进度 类型的字段属性
    property_single_selectobject(SingleSelectFieldProperty)单选 类型的字段属性
    property_referenceobject(PropertyReference)引用 类型的字段属性
    property_locationobject(LocationFieldProperty)地理位置 类型的字段属性
    property_auto_numberobject(AutoNumberFieldProperty)自动编号 类型的字段属性
    property_currencyobject(CurrencyFieldProperty)货币 类型的字段属性
    property_ww_groupobject(WwGroupFieldProperty) 类型的字段属性

    FieldType

    字段类型说明
    FIELD_TYPE_TEXT文本
    FIELD_TYPE_NUMBER数字
    FIELD_TYPE_CHECKBOX复选框
    FIELD_TYPE_DATE_TIME日期
    FIELD_TYPE_IMAGE图片
    FIELD_TYPE_ATTACHMENT文件
    FIELD_TYPE_USER成员
    FIELD_TYPE_URL超链接
    FIELD_TYPE_SELECT多选
    FIELD_TYPE_CREATED_USER创建人
    FIELD_TYPE_MODIFIED_USER最后编辑人
    FIELD_TYPE_CREATED_TIME创建时间
    FIELD_TYPE_MODIFIED_TIME最后编辑时间
    FIELD_TYPE_PROGRESS进度
    FIELD_TYPE_PHONE_NUMBER电话
    FIELD_TYPE_EMAIL邮件
    FIELD_TYPE_SINGLE_SELECT单选
    FIELD_TYPE_REFERENCE关联
    FIELD_TYPE_LOCATION地理位置
    FIELD_TYPE_FORMULA公式
    FIELD_TYPE_CURRENCY货币
    FIELD_TYPE_WWGROUP
    FIELD_TYPE_AUTONUMBER自动编号

    NumberFieldProperty

    数字类型字段属性信息:

    参数名类型描述
    decimal_placesint(DecimalPlaces)表示小数点的位数,即数字精度
    use_separatebool是否使用千位符,设置此属性后数字字段将以英文逗号分隔千分位,如 1,000

    CheckboxFieldProperty

    复选框类型字段属性信息:

    参数名类型描述
    checkedbool新增时是否默认勾选

    DateTimeFieldProperty

    日期类型字段属性信息:

    参数名类型描述
    formatstring(Format)设置日期格式
    auto_fillbool新建记录时,是否自动填充时间

    AttachmentFieldProperty

    文件类型字段属性信息:

    参数名类型描述
    display_modestring(DisplayMode)设置日期格式

    UserFieldProperty

    成员类型字段属性信息:

    参数名类型描述
    is_multiplebool允许添加多个人员
    is_notifiedbool添加人员时通知用户,关闭后不通知

    UrlFieldProperty

    超链接类型字段属性信息:

    参数名类型描述
    typestring(LinkType)超链接展示样式

    SelectFieldProperty

    多选类型字段属性信息:

    参数名类型描述
    is_quick_addbool是否允许填写时新增选项,用户不需要设置该参数
    optionsobject [] ](Option)多选选项的格式设置

    CreatedTimeFieldProperty

    创建时间类型字段属性信息:

    参数名类型描述
    formatstring(Format)设置日期格式

    ModifiedTimeFieldProperty

    最后编辑时间类型字段属性信息:

    参数名类型描述
    formatstring(Format)设置日期格式

    ProgressFieldProperty

    进度类型字段属性信息:

    参数名类型描述
    decimal_placesint(DecimalPlaces)小数位数

    SingleSelectFieldProperty

    单选类型字段属性信息:

    参数名类型描述
    is_quick_addbool是否允许填写时新增选项,用户不需要设置该参数
    optionsobject [] (Option)单选选项的格式设置

    ReferenceFieldProperty

    关联字段属性信息:

    参数名类型描述
    sub_idstring关联的子表id,为空时,表示关联本子表
    filed_idstring关联的字段id
    is_multiplebool是否允许多选
    view_idstring视图id

    LocationFieldProperty

    地理位置字段属性信息:

    参数名类型描述
    input_typestring(LocationInputType)输入类型

    AutoNumberFieldProperty

    自动编号字段属性信息:

    参数名类型描述
    typestring(NumberType)输入类型
    rulesobject[] (NumberRule)自定义规则
    reformat_existing_recordbool是否应用于已有编号

    CurrencyFieldProperty

    货币类型字段属性

    参数名类型描述
    currency_typestring(CurrencyType)输入类型
    decimal_placesint(DecimalPlaces)表示小数点的位数,即数字精度
    use_separatebool是否使用千位符,设置此属性后数字字段将以英文逗号分隔千分位,如 1,000

     

    WwGroupFieldProperty

    群类型的字段属性

    参数名类型描述
    allow_multiplebool是否允许多个群聊

     

    DecimalPlaces

    小数点后的位数:

    数值描述
    -1显示原值
    0代表整数
    1精确到小数点后一位(1.0)
    2精确到小数点后两位(1.00)
    3精确到小数点后三位(1.000)
    4精确到小数点后四位(1.0000)

    Format

    日期格式:

    字符串描述
    "yyyy"年"m"月"d"日""2018 年 4 月 20 日
    "yyyy-mm-dd"2018-04-20
    "yyyy/m/d"2018/4/20
    "m"月"d"日""4 月 20 日
    "yyyy"年"m"月"d"日" dddd"2018 年 4 月 20 日 星期五
    "yyyy"年"m"月"d"日" hh:mm"2018 年 4 月 20 日 14:00
    "yyyy-mm-dd hh:mm"2018-04-20 14:00
    "m/d/yyyy"4/20/2018
    "d/m/yyyy"20/4/2018

    LinkType

    超链接展示样式可选值:

    样式描述
    LINK_TYPE_PURE_TEXT文字
    LINK_TYPE_ICON_TEXT图标文字

    Option

    Option 参数:

    参数名类型描述
    idstring选项 ID
    textstring要填写的选项内容
    styleint(Style)选项颜色

    Style

    选项颜色:

    数值描述
    1浅红
    2浅橙
    3浅天蓝
    4浅绿
    5浅紫
    6浅粉红
    7浅灰
    8

    DisplayMode

    展示样式

    展示样式说明
    DISPLAY_MODE_LIST列表样式
    DISPLAY_MODE_GRID宫格样式

    LocationInputType

    地理位置输入类型

    地理位置输入类型说明
    LOCATION_INPUT_TYPE_MANUAL手动输入
    LOCATION_INPUT_TYPE_AUTO自动定位

    NumberType

    自动编号类型

    自动编号类型说明
    NUMBER_TYPE_INCR自增数字类型
    NUMBER_TYPE_CUSTOM自定义类型

    NumberRule

    自动编号规则类型说明
    typestringNumberRuleType规则类型 
    valuestring存放创建时间格式CreateTimeFormat 或固定字符,自增数字位数 

    CreateTimeFormat

    格式说明
    YYYYMMDD20240301
    YYYYMM202403
    MMDD0301
    YYYY2024
    MM03
    DD01

    NumberRuleType

    数字规则类型

    数字规则类型说明
    NUMBER_RULE_TYPE_INCR自增id
    NUMBER_RULE_TYPE_FIXED_CHAR固定字符
    NUMBER_RULE_TYPE_TIME创建时间

    CurrencyType

    货币符号

    货币符号类型说明
    CURRENCY_TYPE_CNY人民币
    CURRENCY_TYPE_USD美元
    CURRENCY_TYPE_EUR欧元
    CURRENCY_TYPE_GBP英镑
    CURRENCY_TYPE_JPY日元
    CURRENCY_TYPE_KRW韩元
    CURRENCY_TYPE_HKD港元
    CURRENCY_TYPE_MOP澳门元
    CURRENCY_TYPE_TWD新台币
    CURRENCY_TYPE_AED阿联酋迪拉姆
    CURRENCY_TYPE_AUD澳大利亚元
    CURRENCY_TYPE_BRL巴西雷亚尔
    CURRENCY_TYPE_CAD加拿大元
    CURRENCY_TYPE_CHF瑞士法郎
    CURRENCY_TYPE_IDR印尼卢比
    CURRENCY_TYPE_INR印度卢比
    CURRENCY_TYPE_MXN墨西哥比索
    CURRENCY_TYPE_MYR马来西亚林吉特
    CURRENCY_TYPE_PHP菲律宾比索
    CURRENCY_TYPE_PLN波兰兹罗提
    CURRENCY_TYPE_RUB俄罗斯卢布
    CURRENCY_TYPE_SGD新加坡元
    CURRENCY_TYPE_THB泰国铢
    CURRENCY_TYPE_TRY土耳其里拉
    CURRENCY_TYPE_VND越南盾
    上一篇
    查询视图
    下一篇
    查询记录