文档首页/ 智能数据洞察 DataArts Insight/ API参考/ 大屏/ 获取大屏指定组件数据
更新时间：2024-08-28 GMT+08:00
查看PDF
分享

获取大屏指定组件数据

功能介绍

获取大屏指定组件数据。

URI

POST /v1/{project_id}/screens/{screen_id}/query-data

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。获取方法请参考获取项目ID。

最小长度：0

最大长度：128

screen_id

是

String

大屏ID。

最小长度：0

最大长度：128

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Workspace-Id

是

String

工作空间ID，即控制台的项目ID。

最小长度：0

最大长度：128

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取IAM用户Token接口，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。

最小长度：0

最大长度：8192
表3 请求Body参数

参数

是否必选

参数类型

描述

node_id

是

String

组件ID。

最小长度：0

最大长度：128

selectors

否

Array of selectors objects

筛选器列表。

数组长度：0 - 100
表4 selectors

参数

是否必选

参数类型

描述

selector_node_id

否

String

筛选器组件ID。

最小长度：0

最大长度：128

field_id

否

String

筛选器字段ID。

最小长度：0

最大长度：128

values

否

Array of objects

筛选器值。

数组长度：0 - 100

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

cell_data

Array of OpenApiCellInfoList objects

返回数据列表。 cell_data默认第一行为字段名称。

数组长度：0 - 1000

record_count

Integer

返回数据条数。

最小值：0

最大值：1000
表6 OpenApiCellInfoList

参数

参数类型

描述

cell_info_list

Array of OpenApiCellInfo objects

数据列表。

数组长度：0 - 100
表7 OpenApiCellInfo

参数

参数类型

描述

caption

String

字段名称。

最小长度：0

最大长度：128

data_type

String

数据类型：

  • DATETIME：时间类型。
  • STRING：字符类型。
  • NUMBER：数值类型。

最小长度：0

最大长度：128

level_type

String

日期下的子类型，比如年、月、日等。

最小长度：0

最大长度：128

cell_raw_value

Object

字段原始值。

cell_value

Object

字段格式化后的值。

model_type

String

字段类型。

  • dimension：维度。
  • measure：度量。
  • metric：指标。

最小长度：0

最大长度：128

请求示例

获取大屏指定组件数据。

https://{endpoint}/v1/{project_id}/screens/{screen_id}/query-data

{
  "node_id" : "9f7ff361-xxxx-482d-xxxx-57dd19bda14e",
  "selectors" : [ {
    "selector_node_id" : "d1e4b677-xxxx-4016-xxxx-dbd9a4bf2f20",
    "field_id" : "cca5cb5e-xxxx-4614-xxxx-8a4f90447ae0.field",
    "values" : [ "value1" ]
  } ]
}

响应示例

状态码： 200

组件返回数据。

{
  "cell_data" : [ [ {
    "caption" : "create_time(year)",
    "data_type" : "DATETIME",
    "level_type" : "yearLevel",
    "cell_raw_value" : null,
    "cell_value" : "create_time(year)",
    "model_type" : "dimension"
  } ], [ {
    "caption" : "create_time(year)",
    "data_type" : "DATETIME",
    "level_type" : "yearLevel",
    "cell_raw_value" : "2020",
    "cell_value" : "2020",
    "model_type" : "dimension"
  } ] ],
  "record_count" : 1
}

状态码

状态码

描述

200

组件返回数据。

错误码

请参见错误码。

父主题： 大屏

相关文档