文档首页 > > API参考> API> 大屏管理接口> 新增大屏

新增大屏

分享
更新时间: 2019/06/24 16:12

功能介绍

新增一个大屏,大屏的内容来自模板。

URI

  • URI格式

    POST /v1/{project_id}/screens

  • 参数说明
    表1 URI参数说明

    参数名

    是否必选

    参数类型

    参数大小限制

    说明

    project_id

    String

    64

    项目编号,获取方法请参见获取项目ID

请求消息

参数说明:如 表2所示。
表2 参数说明

参数名

是否必选

参数类型

参数大小限制

说明

name

String

32

大屏名称,由数字、字母和中文组成,长度为1~32字符。

alias

String

255

大屏别名,缺省值为空。

description

String

512

大屏的描述信息,缺省值为空。

templateId

String

32

大屏的模板ID,获取方法请参见查询模板列表

响应消息

参数说明:如 表3所示。
表3 参数说明

参数名

参数类型

说明

id

String

大屏ID

name

String

大屏名称

alias

String

大屏别名

description

String

大屏的描述信息

status

Integer

大屏状态:0-created,1- deleted,2-shared

projectId

String

项目编号,即project_id

createUser

String

大屏的创建者

createDate

Integer

大屏的创建时间戳

updateUser

String

大屏的更新者

updateDate

Integer

大屏的更新时间戳

templateId

String

大屏创建时使用的模板ID

snapshotId

String

大屏快照的ID

share

String

大屏分享的UUID标识

thumbnail

String

大屏缩略图的访问地址

config

JSON

大屏的配置内容

示例

创建一个名称为screen_01的大屏,使用的模板ID为32546212564。

  • 请求示例
    POST https://{dlv_endpoint}/v1/{project_id}/screens
    Request Header:
    X-Auth-token: {X-Auth-token}
    Content-Type: application/json    
    Request Body:
    {
    "name":"screen_01",
    "alias":"test_screen_01",
    "description":"for test",
    "templateId":"32546212564"
    }

  • 成功响应示例
    {
        "id": "ff80808167813a360167819d5b640045",
        "name": "screen_01",
        "alias": "test_screen_01",
        "description": "for test",
        "status": 0,
        "projectId": "abcdefghijk0123456",
        "createUser": "a1b2c2d3e4f5g6h5j6k6",
        "createDate": 1544067832676,
        "updateUser": null,
        "updateDate": null,
        "templateId": "32546212564",
        "snapshotId": null,
        "share": null,
        "thumbnail": null,
        "config": {
            "scenes": [
                {
                    "name": "场景1",
                    "layers": [
                        {
                            "id": null,
                            "name": "层1",
                            "coms": []
                        }
                    ]
                }
            ],
            "config": {
                "id": null,
                "screenId": "ff80808167813a360167819d5b640045",
                "grid": null,
                "backgroundImage": "",
                "backgroundColor": null,
                "width": 1920,
                "height": 1080,
                "comList": "",
                "screenshot": null,
                "display": 1,
                "watermarkFlag": null,
                "rulerLines": null,
                "variables": null
            }
        }
    }

  • 失败响应示例
    {
        "errors": [
            {
                "error_code": "DLV.1011",
                "error_msg": "Invalid template id."
            }
        ]
    }

状态码

状态码请参见状态码

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区