Help Center/ DataArts Insight/ API Reference/ Large Screen/ Listing Large Screen Components

Updated on 2025-02-25 GMT+08:00

Online Debugging

CLI Examples

View PDF

Listing Large Screen Components

Function

This API is used to list large screen components.

URI

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

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For how to obtain the project ID, see Obtaining a Project ID.
screen_id	Yes	String	Large screen ID.

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
name	No	String	Component name (fuzzy search).
type	No	String	Component type. Enumerated values: line: line chart. type: combination chart. linebardoubley: dual Y-axis combination chart. linestep: step line chart. pie: pie chart. pie_percent: circular progress bar. rosepie: rose chart. bar: bar chart. barhori: horizontal bar chart. linebar: combination chart. linebardoubley: dual Y-axis combination chart. gantt: gantt chart. map: China map. worldmap: world map. custommap: custom map. img: image. video: video. title: title. text: text. wcloud: word cloud. datetime: timer. table: carousel table. tablepage: table. flask: ticker board. thresholdflask: threshold board. marquee: marquee. broadcastlist: carousel bar chart. treemap: treemap chart. border: border. decorate: decoration. bgcom: background image. fullscreen: full screen. iframe: iFrame. search: search. select: single-select dropdown list. tab: tab list. mutiselect: multi-select dropdown list. dates: date selector. dashboard: dashboard. funnel: funnel chart. tree: tree chart. progress: progress bar. distributionmap: industry distribution chart. milestone: milestone.
has_data_bind	No	Boolean	Whether data is bound to the component.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Workspace-Id	Yes	String	Workspace ID. For how to obtain it, see Obtaining a Workspace ID.
X-Auth-Token	Yes	String	User token. Obtain a user token by calling IAM's "Obtaining a User Token" API. X-Subject-Token in the response header is the desired user token.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
id	String	Large screen ID
name	String	Large screen name.
pages	Array of ScreenPageOpenApiVO objects	Large screen page list.

**Table 5** ScreenPageOpenApiVO
Parameter	Type	Description
id	String	Page ID.
name	String	Page name.
nodes	Array of ScreenNodeOpenApiVO objects	List of components on a page.

**Table 6** ScreenNodeOpenApiVO
Parameter	Type	Description
id	String	Component ID.
name	String	Component name.
type	String	Component type.
hidden	Boolean	Whether the component is hidden.
target_nodes	Array of target_nodes objects	Component associated with an interactive event.

**Table 7** target_nodes
Parameter	Type	Description
id	String	ID of an associated component.
field_id	String	Field ID of the associated component.

Example Request

List large screen components.

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

Example Response

Status code: 200

Large screen components are successfully listed.

{
  "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" : "Single-Select Dropdown List 1",
      "type" : "select",
      "hidden" : false,
      "target_nodes" : [ {
        "id" : "9f7ff361-xxxx-475d-xxxx-57dd19bda14e",
        "field_id" : "cca5cb5e-xxxx-475d-xxxx-8a4f90447ae0.field"
      } ]
    } ]
  } ]
}