智能数据洞察 DataArts Insight
智能数据洞察 DataArts Insight
链接复制成功！
获取大屏组件列表
功能介绍
获取大屏组件列表。
URI
GET /v1/{project_id}/screens/{screen_id}/nodes
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。获取方法请参见获取项目ID。 |
|
screen_id |
是 |
String |
大屏ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
否 |
String |
组件名称（模糊搜索）。 |
|
type |
否 |
String |
组件类型。枚举值：
|
|
has_data_bind |
否 |
Boolean |
组件是否绑定数据。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Workspace-Id |
是 |
String |
工作空间ID。获取方法请参见获取工作空间ID。 |
|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取IAM用户Token接口，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
大屏ID。 |
|
name |
String |
大屏名称。 |
|
pages |
Array of ScreenPageOpenApiVO objects |
大屏Page列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
Page ID。 |
|
name |
String |
Page名称。 |
|
nodes |
Array of ScreenNodeOpenApiVO objects |
Page内组件列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
组件ID。 |
|
name |
String |
组件名称。 |
|
type |
String |
组件类型。 |
|
hidden |
Boolean |
组件是否隐藏。 |
|
target_nodes |
Array of target_nodes objects |
交互事件关联组件。 |
请求示例
获取大屏组件列表。
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 |
大屏组件列表。 |
错误码
请参见错误码。
父主题： 大屏
