查询数据列表

POST

https://api.huoban.com/openapi/v1/dw_item/list

获取数据仓库中指定表格的数据列表。

请求参数

Header 参数

Open-Authorization

string

必需

授权的 API Key

默认值:

Bearer {{API_KEY}}

Body 参数application/json

table_id

integer

表格ID

必需

filter

筛选器

可选

结构详见”开发指南 → 数据筛选器“说明文档

Any of

allOf {2}

One of

And

order

object

排序

可选

field_id

string

排序字段ID

必需

type

string

排序类型

必需

正序：asc，倒序：desc

limit

integer

每页条数

可选

默认 20 条，最大 100 条

offset

integer

分页偏移量

可选

默认0

示例

{
  "table_id": "{{EXT_TABLE_ID}}",
  "filter": {
    "and": [
      {
        "field": "2200000137788634",
        "query": {
          "gte": 100
        }
      },
      {
        "field": "2200000137788650",
        "query": {
          "eq": [
            "1"
          ]
        }
      }
    ]
  },
  "order": {
    "field_id": "created_on",
    "type": "desc"
  },
  "limit": 20,
  "last_item_id": "",
  "with_field_config": 0
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.huoban.com/openapi/v1/dw_item/list' \
--header 'Open-Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "table_id": "{{EXT_TABLE_ID}}",
    "filter": {
        "and": [
            {
                "field": "2200000137788634",
                "query": {
                    "gte": 100
                }
            },
            {
                "field": "2200000137788650",
                "query": {
                    "eq": ["1"]
                }
            }
        ]
    },
    "order": {
        "field_id": "created_on",
        "type": "desc"
    },
    "limit": 20,
    "last_item_id": "",
    "with_field_config": 0
}'

返回响应

🟢200成功

application/json

Body

code

integer

错误码

必需

0 为成功，小于 10000 为系统异常，其他为业务异常

message

string

错误信息

必需

具体的错误原因，code 为 0 时返回“success”

data

object

返回数据

必需

返回具体数据的结构

items

array[object (数据) {7}]

数据列表

必需

meta

object

元数据

必需

用来描述返回数据原始信息

trace_id

string

请求ID

必需

每次请求接口会返回唯一的ID

示例

{
  "code": 0,
  "message": "string",
  "data": {
    "items": [
      {
        "item_id": "string",
        "title": "string",
        "created_on": "string",
        "created_by": {},
        "updated_on": "string",
        "updated_by": {},
        "fields": [
          {}
        ]
      }
    ]
  },
  "meta": {
    "trace_id": "string"
  }
}

修改于 2022-07-04 02:22:16

获取数据仓库表格配置

获取数据详情