文档首页/ 智能数据洞察 DataArts Insight/ API参考/ 大屏/ 获取大屏组件列表 - ListScreenNodes
更新时间:2025-11-25 GMT+08:00
分享

获取大屏组件列表 - ListScreenNodes

功能介绍

获取大屏组件列表。

授权信息

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

URI

GET /v1/{project_id}/screens/{screen_id}/nodes

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

screen_id

String

参数解释:

大屏ID。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

name

String

参数解释:

组件名称。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

type

String

参数解释:

组件类型。

约束限制:

不涉及

取值范围:

  • line:线状图

  • type:折线柱图

  • linebardoubley:双轴折线柱图

  • linestep:台阶图

  • pie:饼状图

  • pie_percent:环形进度条

  • rosepie:玫瑰图

  • bar:柱状图

  • barhori:水平柱状图

  • linebar:折线柱图

  • linebardoubley:双轴折线柱图

  • gantt:甘特图

  • map:中国地图

  • worldmap:世界地图

  • custommap:自定义地图

  • img:图片

  • video:视频

  • title:标题

  • text:文本

  • wcloud:词云

  • datetime:时间器

  • table:表格轮播

  • tablepage:表格

  • flask:数字翻牌器

  • thresholdflask:阈值翻牌器

  • marquee:跑马灯

  • broadcastlist:轮播列表柱状图

  • treemap:矩形树图

  • border:边框

  • decorate:装饰

  • bgcom:背景图

  • fullscreen:全屏

  • iframe:iFrame

  • search:搜索

  • select:单选下拉

  • tab:Tab列表

  • mutiselect:多选下拉框

  • dates:日期选择器

  • dashboard:仪表盘

  • funnel:漏斗图

  • tree:树图

  • progress:进度条

  • distributionmap:产业分布图

  • milestone:里程碑

默认取值:

line

has_data_bind

Boolean

参数解释:

组件是否绑定数据。

约束限制:

不涉及

取值范围:

  • true: 是

  • false: 否

默认取值:

false

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Workspace-Id

String

参数解释:

工作空间ID。获取方法请参见获取工作空间ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

id

String

参数解释:

大屏ID。

取值范围:

不涉及

name

String

参数解释:

大屏名称。

取值范围:

不涉及

pages

Array of ScreenPageOpenApiVO objects

大屏Page列表。

表5 ScreenPageOpenApiVO

参数

参数类型

描述

id

String

参数解释:

Page ID。

取值范围:

不涉及

name

String

参数解释:

Page名称。

取值范围:

不涉及

nodes

Array of ScreenNodeOpenApiVO objects

Page内组件列表。

表6 ScreenNodeOpenApiVO

参数

参数类型

描述

id

String

参数解释:

组件ID。

取值范围:

不涉及

name

String

参数解释:

组件名称。

取值范围:

不涉及

type

String

参数解释:

组件类型。

取值范围:

不涉及

hidden

Boolean

参数解释:

组件是否隐藏。

取值范围:

不涉及

target_nodes

Array of target_nodes objects

交互事件关联组件。

表7 target_nodes

参数

参数类型

描述

id

String

参数解释:

关联组件ID。

取值范围:

不涉及

field_id

String

参数解释:

关联组件字段ID。

取值范围:

不涉及

请求示例

获取大屏组件列表。

GET https://{endpoint}/v1/{project_id}/screens/{screen_id}/nodes?name=node1&type=line&has_data_bind=true

响应示例

状态码:200

大屏组件列表。

{
  "id" : "b7401134-xxxx-4973-xxxx-2b6c1ac3f2f1",
  "name" : "test_screen",
  "pages" : [ {
    "id" : "ae613423-xxxx-475d-xxxx-be6fc28c3d30",
    "name" : null,
    "nodes" : [ {
      "id" : "d1e4b677-xxxx-475d-xxxx-dbd9a4bf2f20",
      "name" : "单选下拉1",
      "type" : "select",
      "hidden" : false,
      "target_nodes" : [ {
        "id" : "9f7ff361-xxxx-475d-xxxx-57dd19bda14e",
        "field_id" : "cca5cb5e-xxxx-475d-xxxx-8a4f90447ae0.field"
      } ]
    } ]
  } ]
}

状态码

状态码

描述

200

大屏组件列表。

错误码

请参见错误码

相关文档