Updated on 2022-02-22 GMT+08:00

Importing a Screen

Function

Import the exported screen to DLV. Before importing a screen, you can call the export API to export the required screen. For details about how to export a screen, see Exporting a Screen. The exported screen file can be imported when required.

URI

  • URI format
    POST /v1/{project_id}/screen/import?workspaceId={workspaceId}
  • 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.

    workspaceId

    Yes

    String

    Workspace ID, which consists of 32 characters. For details about how to obtain the workspace ID, see Obtaining a Workspace ID.

Request

Table 2 describes the request parameters.
Table 2 Request parameters

Parameter

Mandatory

Type

Description

file

Yes

String

Screen file to be imported. The file is in *.zip format. You can call the export API to export a screen. The exported .zip file can be imported to DLV.

Response

Table 3 describes the request parameters.

Table 3 Parameter description

Parameter

Type

Description

is_success

boolean

Specifies whether the import succeeds or not.

statusCode

int

Status code.

message

string

Response message.

Example

  • Request example
    POST https://{dlv_endpoint}/v1/{project_id}/screen/import?workspaceId=86ce107974ce4f93b618acb232863027
    Request header
    
    {
        file:xxx.zip
    }

  • Example of a successful response
    {
        "is_success": true, 
        "statusCode": 200, 
        "message": null 
    }

Status Code

For details about status codes, see Status Codes.