根据ID获取数据集配置

调用此接口需要高级功能BI的授权。

返回响应

🟢200查询到的数据集

application/json

Body

args

array

SQL参数

可选

catalog

object

所属目录

可选

string

目录id

可选

config

object

可选

数据集配置，与数据集类型对应

builtin

object

[内置数据集]配置

可选

sql

string

可选

[sql数据集]sql语句

示例值:

SELECT * FROM cars

table

string

可选

[数据库数据集]数据库表的表名

示例值:

cars

union

allOf {1}

[关联数据集]配置

可选

corrupt

string

可选

createdAt

string <date-time>

创建时间

可选

creator

string

创建用户

可选

dataSourceId

string

必需

所属db类型数据接口组id

datasetType

enum<string>

必需

数据集类型

sql - sql数据集

builtin - 内置数据集

union - 关联数据集

table - 数据库数据集

api - 接口数据集(计划中)

枚举值:

sqlbuiltinuniontableapi

string

可选

id,缺省时生成uuid

name

string

数据集名称

可选

order

number

排序优先级

可选

sql

string

对应SQL

可选

style

object

前端参数

可选

syncMode

enum<integer>

必需

连接模式

1 - 直连

2 - 定时

枚举值:

updatedAt

string <date-time>

修改时间

可选

viewName

string

可选

视图名称(自动生成)

示例

{
  "args": [
    null
  ],
  "catalog": {
    "id": "string"
  },
  "config": {
    "builtin": {
      "config": {},
      "identifier": "log",
      "tableType": "builtin"
    },
    "sql": "SELECT * FROM cars",
    "table": "cars",
    "union": {
      "children": [
        {}
      ],
      "datasetType": "sql",
      "ds": "string",
      "fields": [
        "string"
      ],
      "position": {
        "x": 0,
        "y": 0
      },
      "rel2Parent": {
        "fields": [
          {
            "childField": "string",
            "parentField": "string"
          }
        ],
        "joinType": "inner"
      }
    }
  },
  "corrupt": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "creator": "string",
  "dataSourceId": "string",
  "datasetType": "sql",
  "id": "string",
  "name": "string",
  "order": 0,
  "sql": "string",
  "style": {},
  "syncMode": 0,
  "updatedAt": "2019-08-24T14:15:22Z",
  "viewName": "string"
}

🟠400请求错误,请结合message和detail判断原因

🟠401token无效或过期

🟠403权限错误

🔴500服务器错误

根据ID获取数据集配置

请求参数

示例代码

返回响应