文档首页/数据可视化 DLV/API参考/API/模板管理接口/查询模板列表
更新时间：2022-02-22 GMT+08:00
查看PDF
分享

查询模板列表

功能介绍

查询模板列表。

URI

  • URI格式 
    GET /v1/{project_id}/screens/templates
  • 参数说明
    表1 URI参数说明

    参数

    是否必选

    参数类型

    描述

    project_id

    是

    String

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

请求消息

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

参数

是否必选

参数类型

描述

workspaceId

是

String

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

响应消息

参数说明：如表3所示。
表3 响应参数

参数

参数类型

描述

id

String

模板ID

name

String

模板名称

description

String

模板的描述信息

thumbnail

String

模板缩略图的存储地址

priority

Integer

模板优先级，即模板在控制台中的位置，从左到右，第一位为0。

size

String

模板的屏幕大小

createDate

Long

模板创建时间

updateDate

Long

模板更新时间

status

Integer

模板状态：0-created，1- deleted，2-shared

locale

String

语言标识。

permission

Boolean

是否具有该模板的访问权限。true：有权限。false：无权限。

示例

  • 请求示例 
    GET https://{dlv_endpoint}/v1/{project_id}/screens/templates
{请求消息头}

{
    "workspaceId": "86ce107974ce4f93b618acb232863027"
}

  • 成功响应示例 
    [
    {
        "id": "32546212564",
        "name": "blank_template",
        "description": "在空白画布上尽情施展您的创意吧！",
        "thumbnail": "",
        "priority": 0,
        "size": "尺寸自定",
        "createDate": 1533176653819,
        "updateDate": 1533176653819,
        "status": 0,
        "locale": en-us,
        "permission": true
    }
]

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

状态码

状态码请参见状态码。

父主题：模板管理接口