请求和响应格式

请求格式

GET 请求

对于 GET 请求，所有参数通过拼接在 URL 之后传递。

示例

GET /api/v1/open/app/get?appKey=xxx&sign=xxx

POST / PUT / PATCH / DELETE 请求

对于 POST / PUT / PATCH / DELETE 请求：

• 请求的主体必须是 JSON 格式
• HTTP header 的 Content-Type 需要设置为 application/json

示例

POST /v3/app/worksheets
Content-Type: application/json

{
  "name": "工作表名称",
  "fields": []
}

响应格式

HTTP 状态码

所有响应的 HTTP 状态码都是 200。实际的业务状态通过响应体中的 success 和 error_code 字段表示。

响应内容类型

• 响应的 Content-Type 为 application/json
• 响应的 body 是 JSON 格式

响应结构

成功响应

{
  "success": true,
  "error_code": 1,
  "error_msg": "",
  "data": {
    // 具体数据
  }
}

失败响应

{
  "success": false,
  "error_code": 10101,
  "error_msg": "具体错误信息",
  "data": null
}

响应字段说明

字段	类型	说明
success	boolean	是否调用成功
error_code	integer	错误代码，1 表示成功
error_msg	string	错误消息
data	object/array	响应数据

字段值格式

附件类型字段

[
  {
    "name": "文件名称，带后缀",
    "url": "url/base64"
  }
]

关联记录类型

多条记录 rowId 用逗号(,)分割：

"rowId1,rowId2,rowId3"

日期类型

• 日期：2018-8-8
• 日期时间：2018-8-8 12:00:00

成员类型

人员ID，多个用逗号（,）分割：

"user1,user2,user3"

分页参数

列表查询接口支持分页：

• pageSize：每页数量，最大为 1000
• pageIndex：页码，从 1 开始

工作流触发

默认情况下，创建、更新、删除记录会触发工作流。可通过 triggerWorkflow 参数控制：

• true：触发工作流（默认）
• false：不触发工作流

相关文档

• 错误码说明 - 完整的错误码列表
• 字段类型对照表 - 字段类型和格式说明

---

维护负责人：技术部
最后更新：2025-01-19