伙伴云OpenAPI
  1. 表格数据
伙伴云OpenAPI
  • 开发指南
    • 开发前必读
    • 申请 API Key
    • 基本概念介绍
    • 数据筛选器
    • 更新日志
  • 工作区
    • 获取工作区列表
      GET
    • 获取工作区成员列表
      POST
  • 表格数据
    • 获取表格列表
      POST
    • 获取表格配置
      POST
    • 查询数据列表
      POST
    • 获取数据详情
      POST
    • 创建数据
      POST
    • 更新数据
      PUT
    • 删除数据
      DELETE
    • 批量创建数据
      POST
    • 批量更新或创建数据
      PUT
    • 批量删除数据
      DELETE
  • 数据仓库数据
    • 获取数据仓库表格列表
      POST
    • 获取数据仓库表格配置
      POST
    • 查询数据列表
      POST
    • 获取数据详情
      POST
    • 批量创建数据
      POST
    • 批量更新数据
      PUT
    • 根据数据ID列表更新成相同数据
      PUT
    • 批量删除数据
      DELETE
  • 流程
    • 获取流程列表
    • 查询流程实例列表
    • 获取流程实例详情
    • 获取流程实例的执行记录
    • 查询流程任务列表
    • 获取流程任务详情
  • 文件
    • 批量获取文件详情
    • 上传文件
  • 订阅
    • 订阅事件概述
    • Encrypt Key 加解密
    • 订阅回调事件
    • 添加订阅
    • 取消订阅
    • 获取订阅列表
  • 服务商
    • 获取 access_token
    • 获取服务商的 api_key
    • 获取服务商信息
    • 设置订阅回调地址
    • 获取订阅回调地址
  1. 表格数据

查询数据列表

POST
https://api.huoban.com/openapi/v1/item/list
获取指定表格的数据列表。

请求参数

Header 参数
Open-Authorization
string 
必需
授权的 API Key
默认值:
Bearer {{API_KEY}}
Body 参数application/json
table_id
string 
表格ID或别名
必需
filter
筛选器
可选
结构详见”开发指南 → 数据筛选器“说明文档
Any of
One of
order
object 
排序
可选
field_id
string 
排序字段ID或别名
必需
type
string 
排序类型
必需
正序:asc,倒序:desc
limit
integer 
每页条数
可选
默认 20 条,最大 100 条
offset
integer 
分页偏移量
可选
默认为 0
示例
{
  "table_id": "{{TABLE_ID}}",
  "filter": {
    "and": [
      {
        "field": "2200000137788634",
        "query": {
          "gte": 100
        }
      },
      {
        "field": "2200000137788650",
        "query": {
          "eq": [
            "1"
          ]
        }
      }
    ]
  },
  "order": {
    "field_id": "created_on",
    "type": "desc"
  },
  "limit": 20,
  "offset": 0,
  "with_field_config": 0
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.huoban.com/openapi/v1/item/list' \
--header 'Open-Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "table_id": "",
    "filter": {
        "and": [
            {
                "field": "2200000137788634",
                "query": {
                    "gte": 100
                }
            },
            {
                "field": "2200000137788650",
                "query": {
                    "eq": ["1"]
                }
            }
        ]
    },
    "order": {
        "field_id": "created_on",
        "type": "desc"
    },
    "limit": 20,
    "offset": 0,
    "with_field_config": 0
}'

返回响应

🟢200成功
application/json
Body
code
integer 
错误码
必需
0 为成功,小于 10000 为系统异常,其他为业务异常
message
string 
错误信息
必需
具体的错误原因,code 为 0 时返回“success”
data
object 
返回数据
必需
返回具体数据的结构
total
integer 
表格数据总数
必需
filtered
integer 
筛选出的数据总数
必需
has_more
boolean 
是否有更多数据
必需
true 是,false 否
items
array[object (数据) {7}] 
数据列表
必需
meta
object 
元数据
必需
用来描述返回数据原始信息
trace_id
string 
请求ID
必需
每次请求接口会返回唯一的ID
示例
{
  "code": 0,
  "message": "success",
  "data": {
    "total": 1000,
    "filtered": 100,
    "has_more": true,
    "items": [
      {
        "item_id": "2300000000000001",
        "title": "数据标题",
        "created_by": {
          "user_id": "1024",
          "name": "接口",
          "avatar": "https://hb-v4-public-oss.huoban.com/user_avatar/317474452/0?imageMogr2/thumbnail/128x128>"
        },
        "created_on": "2021-12-15 20:45:25",
        "updated_by": {
          "user_id": "1024",
          "name": "接口",
          "avatar": "https://hb-v4-public-oss.huoban.com/user_avatar/317474452/0?imageMogr2/thumbnail/128x128>"
        },
        "updated_on": "2022-03-31 18:33:15",
        "fields": {
          "2200000137788628": "单行文本",
          "2200000137788629": "多行文本1<br>多行文本2<br>多行文本3",
          "2200000137788630": "<p><b>富文本1</b></p><p><font color=\"#dc0000\">富文本2</font></p><ol><li>富文本3</li><li>富文本4</li></ol>",
          "2200000137788631": "18612345678",
          "2200000137788632": "6954432710706",
          "2200000137788634": 23456,
          "2200000137788635": 0.85,
          "2200000137788642": 234.56,
          "2200000137788643": "2022-03-03",
          "2200000137788644": "2022-03-03 00:00:00",
          "2200000137788645": 23456,
          "2200000137788646": 0.85,
          "2200000137788647": "2022-03-03",
          "2200000137788648": "2022-03-03 00:00:00",
          "2200000137788650": [
            {
              "id": "1",
              "name": "选项1"
            }
          ],
          "2200000137788651": [
            {
              "id": "1",
              "name": "选项1"
            },
            {
              "id": "2",
              "name": "选项2"
            }
          ],
          "2200000137788652": [
            {
              "id": "1",
              "name": "选项1"
            }
          ],
          "2200000137788653": [
            {
              "id": "1",
              "name": "选项1"
            },
            {
              "id": "2",
              "name": "选项2"
            }
          ],
          "2200000137788654": [
            {
              "user_id": "1000001",
              "name": "张三",
              "avatar": "https://hb-v4-public-oss.huoban.com/user_avatar/1000001/0?imageMogr2/thumbnail/128x128>"
            }
          ],
          "2200000137788655": [
            {
              "user_id": "1000001",
              "name": "张三",
              "avatar": "https://hb-v4-public-oss.huoban.com/user_avatar/1000001/0?imageMogr2/thumbnail/128x128>"
            },
            {
              "user_id": "1000002",
              "name": "李四",
              "avatar": "https://hb-v4-public-oss.huoban.com/user_avatar/1000002/0?imageMogr2/thumbnail/128x128>"
            }
          ],
          "2200000137788659": [
            {
              "item_id": "2300000000000011",
              "title": "数据标题1"
            }
          ],
          "2200000137788660": [
            {
              "item_id": "2300000000000011",
              "title": "数据标题1"
            },
            {
              "item_id": "2300000000000012",
              "title": "数据标题2"
            }
          ],
          "2200000137788661": {
            "poi": "青岛大学(浮山校区)",
            "address": "山东省青岛市崂山区宁夏路308号",
            "name": "青岛大学(浮山校区),山东省青岛市崂山区宁夏路308号",
            "pcode": "370000",
            "pname": "山东省",
            "citycode": "0532",
            "cityname": "青岛市",
            "adcode": "370212",
            "adname": "崂山区",
            "coordinate": {
              "lat": 36.071915,
              "lon": 120.422859
            }
          },
          "2200000137788663": [
            {
              "file_id": "188000001",
              "name": "image.png",
              "size": 300,
              "link": {
                "source": "https://hb-v4-attachment-oss.huoban.com/attachment/188000001/0",
                "square": "https://hb-v4-attachment-oss.huoban.com/attachment/188000001/0?imageMogr2/thumbnail/!320x320r|imageMogr2/crop/320x320/gravity/center"
              }
            }
          ],
          "2200000137788666": [
            {
              "file_id": "188000002",
              "name": "file.zip",
              "size": 500,
              "link": {
                "source": "https://hb-v4-attachment-oss.huoban.com/attachment/188000002/0"
              }
            }
          ],
          "2200000137788667": {
            "user": {
              "user_id": "1000001",
              "name": "张三",
              "avatar": "https://hb-v4-public-oss.huoban.com/user_avatar/1000001/0?imageMogr2/thumbnail/128x128>"
            },
            "signature": {
              "time": "2022-03-31 17:06:05",
              "file": {
                "file_id": "188000003",
                "name": "signature.png",
                "size": 9450,
                "link": {
                  "source": "https://hb-v4-attachment-oss.huoban.com/attachment/188000003/0",
                  "square": "https://hb-v4-attachment-oss.huoban.com/attachment/188000003/0?imageMogr2/thumbnail/!320x320r|imageMogr2/crop/320x320/gravity/center"
                }
              }
            }
          }
        }
      }
    ]
  },
  "meta": {
    "trace_id": "1650349377817634"
  }
}
上一页
获取表格配置
下一页
获取数据详情
Built with