查询视图

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

只支持过滤和分页,不支持其他功能(即返回全部字段,无法排序)。在filter中加name和datasetId字段可以根据name和数据集id过滤。

请求参数

Query 参数

query

string

可选

支持复杂的查询表达式,详细的查询参数说明和结构。请参见查询参数文档

示例值:

{"filter":{"datasetId":"aaa"}}

Header 参数

X-Request-Project

string

可选

项目ID, 默认default

Authorization

string

Token

可选

默认值:

返回响应

🟢200查询到的视图

application/json

Body

array of:

catalog

object

所属目录

可选

string

目录id

可选

config

object

查询参数

可选

drill

array[string]

可选

下钻列的originalName或id(未启用)

echartType

string

可选

fields

array[object (entity.SelectField) {3}]

必需

包含查询列（原始列originalName或id）、别名和聚合方法

group

array[object (entity.GroupField) {3}]

可选

聚合的列（原始列的originalName或id）

groupAlias

array[string]

可选

聚合列别名,不为空时长度需要与group相等

limit

integer

查询结果的最大条数

可选

>= 0

默认值:

1000

noGroupBy

boolean

可选

false: groups和stack里的维度列都会被group by

offset

integer

查询结果的偏移量

可选

>= 0

默认值:

order

array[object (entity.OrderByField) {2}]

排序

可选

stack

array[string]

可选

堆叠列的originalName或id(未启用)

where

array [array]

可选

视图所有查询条件组，第一级的条件为或关系，第二级的条件为与关系

corrupt

string

可选

非空时表示可能是由于所属数据集被删除而导致预览出错

createdAt

string <date-time>

创建时间

可选

creator

string

创建用户

可选

datasetId

string

所属数据集ID

可选

string

可选

id,缺省时生成uuid

name

string

视图名称

可选

order

number

排序优先级

可选

style

object

可选

前端配置,与功能无关

updatedAt

string <date-time>

修改时间

可选

示例

[
  {
    "catalog": {
      "id": "string"
    },
    "config": {
      "drill": [
        "string"
      ],
      "echartType": "string",
      "fields": [
        {
          "alias": "string",
          "name": "string",
          "option": {
            "aggregator": "count",
            "defaultValue": null,
            "distinct": true,
            "filter": {
              "name": "string",
              "op": "eq",
              "value": null
            }
          }
        }
      ],
      "group": [
        {
          "alias": "string",
          "name": "*",
          "option": {
            "format": "Y-m-dTH:M:00",
            "method": "$dateToString"
          }
        }
      ],
      "groupAlias": [
        "string"
      ],
      "limit": 1000,
      "noGroupBy": true,
      "offset": 0,
      "order": [
        {
          "desc": true,
          "name": "string"
        }
      ],
      "stack": [
        "string"
      ],
      "where": [
        [
          {
            "name": "string",
            "op": "eq",
            "value": null
          }
        ]
      ]
    },
    "corrupt": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "creator": "string",
    "datasetId": "string",
    "id": "string",
    "name": "string",
    "order": 0,
    "style": {},
    "updatedAt": "2019-08-24T14:15:22Z"
  }
]

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

🟠401token无效或过期

🟠403权限错误

🔴500服务器错误

请求参数

示例代码

返回响应