WeMore Table API
    • WeMore Table API 参考手册 (beta)
    • 数据模型及参数说明手册
    • 用户级 API
      • 用户级 API
      • 获取字段列表
        GET
      • 获取通讯录
        GET
      • 查询数据
        GET
      • 添加数据
        POST
      • 获取行数据
        GET
      • 更新数据
        PUT
      • 删除行数据
        DELETE
      • 获取所有视图
        GET
      • 查看视图
        GET
    • 企业自建型应用 API
      • 企业自建型应用 API 参考手册
      • 获取通讯录
        GET
      • 发送通知
        POST
      • 查询数据
        GET
      • 添加数据
        POST
      • 批量操作
        POST
      • 修改评论
        PUT
      • 删除评论
        DELETE
      • 获取行数据
        GET
      • 更新数据
        PUT
      • 删除行数据
        DELETE
      • 获取评论
        GET
      • 添加评论
        POST
      • 改变行的位置
        PUT
    • 第三方应用提供商 API
      • 第三方应用 API 参考手册
      • 创建系统级应用
        POST
      • 获取通讯录
        GET
      • 发送通知
        POST
      • 查询数据
        GET
      • 添加数据
        POST
      • 批量操作
        POST
      • 修改评论
        PUT
      • 删除评论
        DELETE
      • 获取行数据
        GET
      • 更新数据
        PUT
      • 删除行数据
        DELETE
      • 获取评论
        GET
      • 添加评论
        POST
      • 改变行的位置
        PUT
    • 数据模型
      • Schemas
        • BaseResVo
        • ChangePhoneReq
        • ColumnPermissionDto
        • ConditionDto
        • ContactsVo
        • DataCriterionDto
        • DataPermissionDto
        • DataPermissionVo
        • DepartInfo
        • DepartNodeVo
        • FilterDto
        • GroupDto
        • InviteReq
        • JsonNode
        • RowActivityVo
        • R«BaseResVo»
        • R«ContactsVo»
        • R«DepartNodeVo»
        • R«List«BaseResVo»»
        • R«List«openapi行信息»»
        • R«List«列元数据信息vo»»
        • R«List«创建 Webhook 返回»»
        • R«List«回收站列表数据»»
        • R«List«工作空间信息»»
        • R«List«应用信息vo»»
        • R«List«快照信息vo»»
        • R«List«批量创建返回值»»
        • R«List«权限返回信息»»
        • R«List«移动后的位置信息»»
        • R«List«自动化vo»»
        • R«List«行信息控制vo»»
        • R«List«行元数据信息vo»»
        • R«List«视图信息vo»»
        • R«List«角色权限信息vo»»
        • R«RowActivityVo»
        • R«SimpleSearchContactVo»
        • R«StatisticVo»
        • R«TokenInfo»
        • R«checkPoint 分页-请求«openapi行信息»»
        • R«checkPoint 分页-请求«行动态信息vo»»
        • R«object»
        • R«offset 分页-返回«openapi行信息»»
        • R«offset 分页-返回«机器人消息通知vo»»
        • R«offset 分页-返回«行元数据信息vo»»
        • R«offset 分页-返回«通知信息vo»»
        • R«openapi行信息»
        • R«string»
        • R«列添加返回信息vo»
        • R«创建 Webhook 返回»
        • R«工作空间信息»
        • R«工作空间基础信息»
        • R«应用信息vo»
        • R«应用基础信息vo»
        • R«应用基础信息vo»_1
        • R«应用详情vo»
        • R«成员信息»
        • R«撤销返回信息»
        • R«新增部门返回信息»
        • R«添加行返回的信息»
        • R«用户信息»
        • R«登录信息»
        • R«粘贴单元格返回»
        • R«自动化vo»
        • R«行元数据信息vo»
        • R«行动态信息vo»
        • R«行锁vo»
        • R«表单视图信息»
        • R«表基础信息vo»
        • R«表基础信息vo»_1
        • R«表格预览相应参数»
        • R«表详情信息vo»
        • R«视图信息vo»
        • R«视图通用信息vo»
        • R«角色信息vo»
        • R«角色权限信息vo»
        • SendCodeReq
        • SendMsgReq
        • SimpleSearchContactVo
        • SortDto
        • StatisticVo
        • TokenInfo
        • TotalUseVo
        • UpdateUserInfoReq
        • Webhook 请求头
        • checkPoint 分页-请求«openapi行信息»
        • checkPoint 分页-请求«行动态信息vo»
        • offset 分页-返回«openapi行信息»
        • offset 分页-返回«机器人消息通知vo»
        • offset 分页-返回«行元数据信息vo»
        • offset 分页-返回«通知信息vo»
        • openapi行信息
        • 企业登录请求
        • 修改视图可见性参数
        • 修改视图统计函数参数
        • 修改语言
        • 修改部门请求
        • 分配部门请求参数
        • 列元数据信息vo
        • 列基本信息dto
        • 列显示dto
        • 列添加返回信息vo
        • 创建 Webhook 参数
        • 创建 Webhook 返回
        • 创建快照dto
        • 创建系统应用dto
        • 创建自动化dto
        • 创建行dto
        • 创建角色dto
        • 创建，修改应用dto
        • 动作执行dto
        • 单元格数据dto
        • 单元格数据vo
        • 单元格数据删除dto
        • 发送邮箱验证码
        • 回收站列表数据
        • 复制表
        • 导入表格数据参数
        • 工作空间dto
        • 工作空间信息
        • 工作空间基础信息
        • 应用信息vo
        • 应用基础信息vo
        • 应用基础信息vo_1
        • 应用基础信息vo_2
        • 应用详情vo
        • 必填dto
        • 快照信息vo
        • 成员信息
        • 手机号登录
        • 批量修改行参数
        • 批量创建返回值
        • 批量删除行参数
        • 批量操作的参数
        • 批量操作的参数_1
        • 插入行dto
        • 撤销返回信息
        • 改变位置dto
        • 新增部门请求
        • 新增部门返回信息
        • 机器人消息通知vo
        • 权限返回信息
        • 添加列dto
        • 添加用户订阅行动态
        • 添加行返回的信息
        • 添加评论dto
        • 添加评论请求参数
        • 用户信息
        • 用户信息dto
        • 登录信息
        • 移动后的位置信息
        • 粘贴单元格参数
        • 粘贴单元格返回
        • 给角色添加用户dto
        • 自动化vo
        • 自动化状态dto
        • 节点信息dto
        • 行信息控制vo
        • 行元数据信息vo
        • 行动态信息vo
        • 行动态信息vo_1
        • 行锁vo
        • 表单视图信息
        • 表单视图修改参数
        • 表单视图分享参数
        • 表单视图分享参数返回
        • 表单视图列的配置
        • 表和列信息vo
        • 表基础信息vo
        • 表基础信息vo_1
        • 表基础信息vo_2
        • 表格预览相应参数
        • 表格预览请求参数
        • 表设置信息vo
        • 表详情信息vo
        • 视图信息vo
        • 视图列信息vo
        • 视图列基本信息
        • 视图创建dto
        • 视图通用信息vo
        • 角色信息vo
        • 角色权限信息vo
        • 解析公式参数
        • 触发器dto
        • 订阅行动态参数
        • 设置密码
        • 评论内容
        • 通知信息vo
        • 邮箱登录
        • 重置手机号密码
        • 重置邮箱密码

    WeMore Table API 参考手册 (beta)

    提醒：
    当前 API 处于 beta 阶段，我们可能会添加新的接口返回值属性，但不会删除已经存在的属性。如果 API 没有返回你需要的数据，欢迎向我们反馈。
    这份参考手册旨在帮助你全面了解 WeMore Table API。
    通过本页面左边的导航区域，你可以找到每种 API 接口（包括记录、字段、视图、附件、空间站、工作目录）的详细信息。
    通过本页面右边的代码区域，你可以找到每种 API 接口的请求示例和响应示例，方便你直接复制需要的代码。

    介绍#

    WeMore Table API 请求的基本 URL 是 https://api.wemore.com/foxTable/。
    但不同类型的 API，baseUrl 路径稍有不同：
    用户级 API：https://api.wemore.com/foxTable/openApi/v1/
    企业自建型应用 API：https://api.wemore.com/foxTable/thirdApi/v1/
    企业自建型应用 API：https://api.wemore.com/foxTable/thirdApi/v1/
    注意：必须使用 https 请求，不能使用 http 请求。
    WeMore Table API 尽可能遵循 RESTful 惯例，即通过对空间和数据表资源的 GET、POST、PUT 和 DELETE 请求进行数据的增删改查。
    注意没有PATCH请求，大部分更新操作都是PUT
    请求和响应体均被编码为 JSON 格式。
    JSON 中的参数名称使用驼峰命名法（如 viewId），对大小写敏感。

    认证#

    通过在请求头上携带认证信息，但不同级别的 API 认证方式各有不同，具体看对应级别的 API 手册。

    限制#

    发送 API 请求时，你需要注意以下几种限制：频率限制、接口限制、用量限制。

    频率限制#

    同一个用户对同一张表的 API 请求频率上限为 5 次/秒。
    请求频率超过限制时，会提示错误“操作太频繁”（错误状态码 429）。

    接口限制#

    获取记录接口：一次最多获取 1000 行记录。
    比如想批量获取 10000 行记录，至少需要调用 10 次获取记录接口。
    创建记录接口：一次最多创建 10 行记录。
    比如想批量创建 1000 行记录，至少需要调用 100 次创建记录接口。
    更新记录接口：一次最多更新 10 行记录。
    比如想批量更新 1000 行记录，至少需要调用 100 次更新记录接口。
    删除记录接口：一次最多删除 10 行记录。
    比如想批量删除 1000 行记录，至少需要调用 100 次删除记录接口。
    上传附件接口：一次只可上传 1 个附件。
    如果需要上传多份文件，需要重复调用此接口。

    用量限制#

    用量限制包含两种：一是 API 用量的限制；二是空间资源用量的限制。
    Plus 和 Pro 空间每月可免费调用 10000 次 API，累计用量每月 1 号 0 点清零。
    公测阶段，你可以创建最多 1000 张表。单个表最多支持创建 1,200行记录、200 个字段、30 个视图。
    单个空间站上传附件的容量上限为 1 GB。
    版本FreePlusPro
    单应用最大数据(记录)量1,2005,00050,000
    单文件上传限制5MB2GB2GB
    空间最大附件量1GB5GB * 人数10GB * 人数
    OpenAPI10,000 次每月50,000 次每月100,000 次每月

    状态码#

    每次发送 API 请求时，程序都会返回业务状态码和对应消息。
    如果请求失败，你可以根据返回的状态码及报错消息进行排查。
    HTTP 状态码返回消息业务状态码说明
    200SUCCESS200GET、POST、PUT、DELETE 请求正常并按预期返回结果
    400（参考具体的错误消息）400参数异常，数据校验异常
    401鉴权失败401可能的情况：
    - 需要用户登录
    - 请求头没有传入正确的 API Token
    403禁止访问403可能的情况：
    - 没有权限此接口
    - API 调用次数已超出限额
    404找不到指定的资源404可能的情况：
    - 数据表可能对用户不可见、或不存在、或已被删除
    - 接口不存在
    429操作太频繁429同一用户对同一张表的请求频率上限为 5 次/秒
    500SERVER_ERROR (code)内部服务发生未处理的异常
    200 上传附件失败 426
    情况：
    ① 附件超出 1 GB 的大小限制500 1
    ② 空间站的附件容量已达上限
    200 上传附件个数超出限制 428 上传附件每次调用仅可上传一个，超出会报此错误
    200 无节点权限操作 602 用户无指定数据表的访问权限（比如可管理、可编辑或只读）
    200 （参考具体的错误消息） 400 参数异常，数据校验异常
    ① 请求头没有传入 API Token
    ② API Token 不正确
    403 禁止访问 403 可能的情况：
    ① API 调用次数已经超出限制
    ② 无法获得空间站的 API 用量额度，请稍后再试
    429 操作太频繁 429 同一用户对同一张表的请求频率上限为 5 次/秒
    200 您的功能使用量已经超出「公测版」50000行的限制 304 表的行数已经达到单表行数上限，请尽快更换数表，以免出现数据丢失的情况

    扫码联系专属客服

    在这里，可获得 WeMore 使用上的任何帮助，快速上手让你的效率得到大幅提升

    专属客服
    修改于 2022-07-07 08:17:05
    下一页
    数据模型及参数说明手册
    Built with