Help Center> Data Lake Visualization> API Reference> DLV APIs> Screen Management> Changing a Screen Name
View PDF

Changing a Screen Name

Function

Change a screen name.

URI

  • URI format 
    PUT /v1/{project_id}/screens/{screen_id}
  • 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.

    screen_id

    Yes

    String

    Screen ID. For details about how to obtain the screen ID, see Obtaining a Screen List.

Request

Table 2 describes the request parameters.
Table 2 Request parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Name of the screen. A screen name contains 1 to 32 characters and consists of digits and letters.

workspaceId

Yes

String

Workspace ID, which contains 32 characters.

Response

Table 3 describes the response parameters.

Table 3 Response parameters

Parameter

Type

Description

is_success

Boolean

Specifies whether the operation is successful. true: The operation is successful. false: The operation failed.

statusCode

Integer

Status codes.

message

String

Message returned.

Examples

Change the name of the screen whose ID is ff80808167813a360167819d5b640045 to screen_01_change.

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

{
    "name":"screen_01_change",
    "workspaceId":"86ce107974ce4f93b618acb232863027"}
  • Example of a successful response 
    {
    "is_success": true,
    "statusCode": 200,
    "message": null
}
  • 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