获取大屏指定组件数据 - ShowScreenNodeQueryData

功能介绍

获取大屏指定组件数据。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

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

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：项目ID。获取方法请参见获取项目ID。约束限制：不涉及取值范围：不涉及默认取值：不涉及
screen_id	是	String	参数解释：大屏ID。约束限制：不涉及取值范围：不涉及默认取值：不涉及

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Workspace-Id	是	String	参数解释：工作空间ID。获取方法请参见获取工作空间ID。约束限制：不涉及取值范围：不涉及默认取值：不涉及
X-Auth-Token	是	String	参数解释：用户Token。通过调用IAM服务获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。约束限制：不涉及取值范围：不涉及默认取值：不涉及

表3 请求Body参数
参数	是否必选	参数类型	描述
node_id	是	String	参数解释：组件ID。取值范围：不涉及
selectors	否	Array of selectors objects	筛选器列表。

表4 selectors
参数	是否必选	参数类型	描述
selector_node_id	否	String	参数解释：筛选器组件ID。取值范围：不涉及
field_id	否	String	参数解释：筛选器字段ID。取值范围：不涉及
values	否	Array of objects	参数解释：筛选器值。取值范围：不涉及

响应参数

状态码：200

表5 响应Body参数
参数	参数类型	描述
cell_data	Array of OpenApiCellInfoList objects	返回数据列表。 cell_data 默认第一行元素为字段名称。
record_count	Integer	参数解释：返回数据条数。取值范围：不涉及

表6 OpenApiCellInfoList
参数	参数类型	描述
cell_info_list	Array of OpenApiCellInfo objects	数据列表。

表7 OpenApiCellInfo
参数	参数类型	描述
caption	String	参数解释：字段名称。取值范围：不涉及
data_type	String	参数解释：数据类型。取值范围： DATETIME：时间类型 STRING：字符类型 NUMBER：数值类型
level_type	String	参数解释：日期下的子类型。取值范围：不涉及
cell_raw_value	Object	参数解释：字段原始值。取值范围：不涉及
cell_value	Object	参数解释：字段格式化后的值。取值范围：不涉及
model_type	String	参数解释：字段类型。取值范围： dimension：维度 measure：度量 metric：指标

请求示例

获取大屏指定组件数据。

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
}