Help Center> Data Lake Visualization> API Reference> DLV APIs> Screen Management> Obtaining a Screen List
View PDF

Obtaining a Screen List

Function

Obtain a screen list.

URI

  • URI format 
    GET /v1/{project_id}/screens
  • Parameter description
    Table 1 URI parameter description

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Request

Table 2 describes the request parameters.
Table 2 Request parameters

Parameter

Mandatory

Type

Description

workspaceId

Yes

String

Workspace ID, which contains 32 characters.

Response

Table 3 describes the response parameters.

Table 3 Response parameters

Parameter

Type

Description

screens

Array of screen objects

Screen list.

maxScreenNuM

Integer

The maximum number of the screens that can be created.

currentNum

Integer

Number of screens created in the current project.

domainScreenNum

Integer

Number of screens created for all projects in the current region.
Table 4 screen

Parameter

Type

Description

id

String

ID of the screen.

name

String

Name of the screen.

alias

String

Alias of the screen.

description

String

Description of the screen.

status

Integer

Status of the screen: 0-created, 1-deleted, 2-shared

projectId

String

ID of the project.

createUser

String

Creator of the screen.

createDate

Integer

Timestamp for creating the screen.

updateUser

String

User who updates the screen.

updateDate

Integer

Timestamp for updating the screen.

templateId

String

ID of the template used for creating the screen.

snapshotId

String

ID of the screen snapshot.

share

String

UUID for sharing the screen.

thumbnail

String

URL for accessing the screen thumbnail.

width

Integer

Screen width in units of pixels.

height

Integer

Screen height in units of pixels.

password

String

Password for accessing the screen

token

String

Token for accessing the screen.

Examples

  • Request example 
    GET https://{dlv_endpoint}/v1/{project_id}/screens
Request header

{
    "workspaceId": "86ce107974ce4f93b618acb232863027"
}

  • Example of a successful response 
    {
    "screens": [
        {
            "id": "ff80808167813a360167819d5b640045",
            "name": "screen_01",
            "alias": "test_screen_01",
            "description": null,
            "status": 2,
            "projectId": "abcdefghijk0123456",
            "createUser": "a1b2c2d3e4f5g6h5j6k6",
            "createDate": 1544067832676,
            "updateUser": null,
            "updateDate": 0,
            "templateId": "32546212564",
            "snapshotId": null,
            "share": "f7c9a336e6c74ca5883a60af882d92de",
            "thumbnail": null,
            "width": 1920,
            "height": 1080,
            "password": null,
            "token": null
        },
        {
            "id": "ff808081674bb2e401675002b5950120",
            "name": "Test_done",
            "alias": "",
            "description": null,
            "status": 2,
            "projectId": "abcdefghijk0123456",
            "createUser": "a1b2c2d3e4f5g6h5j6k6",
            "createDate": 1543235614101,
            "updateUser": "a1b2c2d3e4f5g6h5j6k6",
            "updateDate": 1543238083522,
            "templateId": "32546212564",
            "snapshotId": null,
            "share": "e3f93ab1474f43ff8e45ddaa90157d30",
            "thumbnail": null,
            "width": 1920,
            "height": 1080,
            "password": null,
            "token": null
        }

    ],
    "maxScreenNuM": 20,
    "currentNum": 2,
    "domainScreenNum": 2
}
  • Example of a failed response 
    {
    "errors": [
        {
            "error_code": "1004",
            "error_msg": "The operation with the resource entity occur some error."
        }
    ]
}

Status Codes

For details about status codes, see Status Codes.

Parent topic: Screen Management