文档首页/ 数据可视化 DLV/ API参考/ API/ 大屏管理接口/ 导出大屏
更新时间：2021-03-18 GMT+08:00
查看PDF
分享

导出大屏

功能介绍

导出指定的大屏。

URI

  • URI格式 
    GET /v1/{project_id}/screen/{screen_id}/export
  • 参数说明
    表1 URI参数说明

    参数

    是否必选

    参数类型

    描述

    project_id

    是

    String

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

    screen_id

    是

    String

    被导出的大屏ID，获取方法请参见查询大屏列表。

请求消息

参数说明：如表2所示。
表2 请求参数

参数

是否必选

参数类型

描述

workspaceId

是

String

工作空间ID，长度为32个字符，获取方法请参见获取workspaceId。

响应消息

参数说明：如表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

大屏的配置内容

示例

  • 请求示例 
    GET https://{dlv_endpoint}/v1/{project_id}/screens/{screen_id}/export?workspaceId=86ce107974ce4f93b618acb232863027{请求消息头}

  • 成功响应示例 
    {
    二进制流
}

  • 失败响应示例 
    {
    "errors": [
        {
            "error_code": "1004",
            "error_msg": "The operation with the resource entity occur some error."
        }
    ]
}

状态码

状态码请参见状态码。

父主题： 大屏管理接口

相关文档