文档首页/ 智能数据洞察 DataArts Insight/ API参考/ 大屏/ 获取大屏组件列表
更新时间：2024-07-31 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取大屏组件列表

功能介绍

获取大屏组件列表。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

最小长度：0

最大长度：128

screen_id

是

String

大屏ID。

最小长度：0

最大长度：128
表2 Query参数

参数

是否必选

参数类型

描述

name

否

String

组件名称（模糊搜索）。

最小长度：1

最大长度：32

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：里程碑。

最小长度：0

最大长度：32

has_data_bind

否

Boolean

组件是否绑定数据。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Workspace-Id

是

String

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

最小长度：0

最大长度：128

X-Auth-Token

是

String

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

最小长度：0

最大长度：8192

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

id

String

大屏ID。

最小长度：0

最大长度：128

name

String

大屏名称。

最小长度：0

最大长度：32

pages

Array of ScreenPageOpenApiVO objects

大屏Page列表。

数组长度：0 - 100
表5 ScreenPageOpenApiVO

参数

参数类型

描述

id

String

Page ID。

最小长度：0

最大长度：128

name

String

Page名称。

最小长度：0

最大长度：32

nodes

Array of ScreenNodeOpenApiVO objects

Page内组件列表。

数组长度：0 - 1000
表6 ScreenNodeOpenApiVO

参数

参数类型

描述

id

String

组件ID。

最小长度：0

最大长度：128

name

String

组件名称。

最小长度：0

最大长度：32

type

String

组件类型。

最小长度：0

最大长度：32

hidden

Boolean

组件是否隐藏。

target_nodes

Array of target_nodes objects

交互事件关联组件。

数组长度：0 - 100
表7 target_nodes

参数

参数类型

描述

id

String

关联组件ID。

最小长度：0

最大长度：128

field_id

String

关联组件字段ID。

最小长度：0

最大长度：128

请求示例

获取大屏组件列表。

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

大屏组件列表。

错误码

请参见错误码。

父主题： 大屏

相关文档