Listing Dashboards or Large Screens

Function

This API is used to list dashboards or large screens.

URI

GET /v1/{project_id}/resources/{resource_type}

**Table 1** URI parameter
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For how to obtain a project ID, see Obtaining a Project ID.
resource_type	Yes	String	Explanation Enumerated value of the resource type, which is used to specify the type of the authorized object. For example, datasource indicates that the type of the authorized object is a data source. Constraints N/A Value range The enumerated values are: datasource: data source. dataset: dataset. metric: indicator. dashboard: dashboard. screen: large screen. embedAnalysis: embedded analytics. portal: data portal. subject: intelligent analysis assistant. Default value N/A

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Offset.
limit	No	Integer	Maximum number of returned items allowed.
sort_key	No	String	Sorting field.
sort_dir	No	String	Sorting type. The options include: desc: descending order. asc: ascending order.

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
count	Integer	Total number.
page_data	Array of Table 5 objects	Pagination data.

**Table 5** ResourceVO
Parameter	Type	Description
id	String	ID.
name	String	Resource name.
create_user_name	String	Creator.
create_date	Integer	Creation date.
update_user_name	String	User who performs the update.
update_date	Integer	Update date.
status	Integer	Publish status.

Example Request

List large screens.

GET https://{endpoint}/v1/0e****127d****6b7****95750da/resources/screen

Example Response

Status code: 200

Resources are successfully listed.

{
  "count" : 1,
  "page_data" : [ {
    "id" : "e2xxxx66f-81bxxxxxx9c38-80xxx0fxx9c84",
    "name": "Unnamed Large Screen 1",
    "create_user_name" : "dat***ig***",
    "create_date" : 1707215155901,
    "update_user_name" : "dat***ig***",
    "update_date" : 1707215155901,
    "status" : 0
  } ]
}