Copying a Screen

Function

Copy a screen.

URI

URI format

POST /v1/{project_id}/screens/{screen_id}/copy

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 copied. 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** Response 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.

Examples

Request example

POST https://{dlv_endpoint}/v1/{project_id}/screens/ff80808167813a360167819d5b640045/copy
Request header

{
    "workspaceId": "86ce107974ce4f93b618acb232863027"
}

Example of a successful response

{
    "id": "ff80808167813a360167825a27b00073",
    "name": "screen_01_copy",
    "alias": "test_screen_01",
    "description": "for test",
    "status": 0,
    "projectId": "abcdefghijk0123456",
    "createUser": "a1b2c2d3e4f5g6h5j6k6",
    "createDate": 1544080205744,
    "updateUser": null,
    "updateDate": null,
    "templateId": "32546212564",
    "snapshotId": null,
    "share": null,
    "thumbnail": null,
    "config": null
}

Example of a failed response

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