获取数据仓库表格配置

POST

https://api.huoban.com/openapi/v1/dw_table/{table_id}

获取数据仓库中指定表格的详细字段配置。

请求参数

Path 参数

table_id

string

必需

示例值:

Header 参数

Open-Authorization

string

必需

授权的 API Key

默认值:

Bearer {{API_KEY}}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST 'https://api.huoban.com/openapi/v1/dw_table/{{EXT_TABLE_ID}}' \
--header 'Open-Authorization;'

返回响应

🟢200成功

application/json

Body

code

integer

错误码

必需

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

message

string

错误信息

必需

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

data

object

返回数据

必需

返回具体数据的结构

table

object (数据仓库表格配置)

必需

meta

object

元数据

必需

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

trace_id

string

请求ID

必需

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

示例

{
  "code": 0,
  "message": "string",
  "data": {
    "table": {
      "table_id": "string",
      "alias": "string",
      "name": "string",
      "type": "sync",
      "created_on": "string",
      "space_id": "string",
      "fields": [
        {
          "field_id": "string",
          "alias": "string",
          "name": "string",
          "field_type": "input",
          "data_type": "text",
          "config": {
            "precision": 0,
            "unit_prefix": "string",
            "unit_surfix": "string",
            "is_percent": "string"
          },
          "from_relation_field": {
            "field_id": "string"
          },
          "required": true,
          "description": "string"
        }
      ]
    }
  },
  "meta": {
    "trace_id": "string"
  }
}

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

获取数据仓库表格列表

查询数据列表