Exporting a Screen

Function

Export a specified screen.

URI

URI format

GET /v1/{project_id}/screen/{screen_id}/export

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	ID of the screen to be exported. For details about how to obtain the ID, see Obtaining a Screen List.

Request

Table 2 describes the request parameters.

**Table 2** Request parameters
Parameter	Mandatory	Type	Description
workspaceId	Yes	String	Workspace ID, which consists of 32 characters. For details about how to obtain the workspace ID, see Obtaining a Workspace ID.

Response

Table 3 describes the response parameters.

**Table 3** Parameter description
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.
config	JSON	Configuration content of the screen.

Example

Request example

GET https://{dlv_endpoint}/v1/{project_id}/screens/{screen_id}/export?workspaceId=86ce107974ce4f93b618acb232863027{Request header}

Example of a successful response
```
{
    Binary stream
}
```

Example of a failed response

{
    "errors": [
        {
            "error_code": "1004",
            "error_msg": "The operation with the resource entity occur some error."
        }
    ]
}