智能数据洞察 DataArts Insight
智能数据洞察 DataArts Insight
链接复制成功!
获取大屏指定组件数据
功能介绍
获取大屏指定组件数据。
URI
POST /v1/{project_id}/screens/{screen_id}/query-data
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID。获取方法请参见获取项目ID。 |
screen_id |
是 |
String |
大屏ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Workspace-Id |
是 |
String |
工作空间ID。获取方法请参见获取工作空间ID。 |
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取IAM用户Token接口,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
node_id |
是 |
String |
组件ID。 |
selectors |
否 |
Array of selectors objects |
筛选器列表。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
cell_data |
Array of OpenApiCellInfoList objects |
返回数据列表。 cell_data默认第一行为字段名称。 |
record_count |
Integer |
返回数据条数。 |
请求示例
获取大屏指定组件数据。
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 |
组件返回数据。 |
错误码
请参见错误码。
父主题: 大屏